photobiology (version 0.9.16)

absorptance: Absorptance

Description

Function to calculate the mean, total, or other summary of absorptance for spectral data stored in a filter_spct or in an object_spct. Absorptance is a different quantity than absorbance.

Usage

absorptance(spct, w.band, quantity, wb.trim, use.hinges, ...)
# S3 method for default
absorptance(spct, w.band, quantity, wb.trim, use.hinges, ...)
# S3 method for filter_spct
absorptance(spct, w.band = NULL, quantity = "average",
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.hinges = getOption("photobiology.use.hinges", default = NULL), ...)
# S3 method for object_spct
absorptance(spct, w.band = NULL, quantity = "average",
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.hinges = getOption("photobiology.use.hinges", default = NULL), ...)
# S3 method for filter_mspct
absorptance(spct, w.band = NULL,
  quantity = "average", wb.trim = getOption("photobiology.waveband.trim",
  default = TRUE), use.hinges = getOption("photobiology.use.hinges", default =
  NULL), ..., idx = !is.null(names(spct)))
# S3 method for object_mspct
absorptance(spct, w.band = NULL,
  quantity = "average", wb.trim = getOption("photobiology.waveband.trim",
  default = TRUE), use.hinges = getOption("photobiology.use.hinges", default =
  NULL), ..., idx = !is.null(names(spct)))

Arguments

spct

an R object

w.band

waveband or list of waveband objects or a numeric vector of length two. The waveband(s) determine the region(s) of the spectrum that are summarized. If a numeric range is supplied a waveband object is constructed on the fly from it.

quantity

character string One of "average" or "mean", "total", "contribution", "contribution.pc", "relative" or "relative.pc"

wb.trim

logical Flag if wavebands crossing spectral data boundaries are trimmed or ignored

use.hinges

logical Flag indicating whether to use hinges to reduce interpolation errors

...

other arguments (possibly ignored)

idx

logical whether to add a column with the names of the elements of spct

Value

A single numeric value with no change in scale factor, except in the case of percentages (absorptance is the fraction absorbed)

Methods (by class)

• default: Default for generic function

• filter_spct: Specialization for filter spectra

• object_spct: Specialization for object spectra

• filter_mspct: Calculates absorptance from a filter_mspct

• object_mspct: Calculates absorptance from a object_mspct

Examples

# NOT RUN {
absorptance(black_body.spct, new_waveband(400,500))
absorptance(white_body.spct, new_waveband(300,400))
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3))
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3),
        quantity = "average")
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3),
        quantity = "total")
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3),
        quantity = "relative")
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3),
        quantity = "relative.pc")
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3),
        quantity = "contribution")
absorptance(black_body.spct, split_bands(c(400,700), length.out = 3),
        quantity = "contribution.pc")

# }