Summary transmittance for supplied wavebands from filter or object spectrum.
transmittance(spct, w.band, quantity, wb.trim, use.hinges, ...)# S3 method for default
transmittance(spct, w.band, quantity, wb.trim, use.hinges, ...)
# S3 method for filter_spct
transmittance(
spct,
w.band = NULL,
quantity = "average",
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.hinges = NULL,
naming = "default",
...
)
# S3 method for object_spct
transmittance(
spct,
w.band = NULL,
quantity = "average",
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.hinges = NULL,
naming = "default",
...
)
# S3 method for filter_mspct
transmittance(
spct,
w.band = NULL,
quantity = "average",
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.hinges = getOption("photobiology.use.hinges", default = NULL),
naming = "default",
...,
attr2tb = NULL,
idx = "spct.idx"
)
# S3 method for object_mspct
transmittance(
spct,
w.band = NULL,
quantity = "average",
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.hinges = getOption("photobiology.use.hinges", default = NULL),
naming = "default",
...,
attr2tb = NULL,
idx = "spct.idx",
.parallel = FALSE,
.paropts = NULL
)
A named numeric vector in the case of methods for individual
spectra, with one value for each waveband passed to parameter
w.band. A data.frame in the case of collections of spectra,
containing one column for each waveband object, an index column with
the names of the spectra, and optionally additional columns with metadata
values retrieved from the attributes of the member spectra.
By default values are only integrated, but depending on the argument passed
to parameter quantity they can be re-expressed as relative fractions
or percentages. In the case of vector output, names attribute is set
to the name of the corresponding waveband unless a named list is supplied
in which case the names of the list members are used.
an R object.
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.
character string One of "average" or "mean",
"total", "contribution", "contribution.pc",
"relative" or "relative.pc".
logical if TRUE wavebands crossing spectral data
boundaries are trimmed, if FALSE, they are discarded.
logical Flag indicating whether to insert "hinges" into the spectral data before integration so as to reduce interpolation errors at the boundaries of the wavebands.
ignored (possibly used by derived methods).
character one of "long", "default",
"short" or "none". Used to select the type of names to assign
to returned value.
character vector, see add_attr2tb for the syntax for attr2tb passed as is to formal parameter col.names.
character Name of the column with the names of the members of the collection of spectra.
if TRUE, apply function in parallel, using parallel backend provided by foreach
a list of additional options passed into the foreach function when parallel computation is enabled. This is important if (for example) your code relies on external data or packages: use the .export and .packages arguments to supply them so that all cluster nodes have the correct environment set up for computing.
transmittance(default): Default method
transmittance(filter_spct): Method for filter spectra
transmittance(object_spct): Method for object spectra
transmittance(filter_mspct): Calculates transmittance from a filter_mspct
transmittance(object_mspct): Calculates transmittance from a object_mspct
transmittance(polyester.spct, waveband(c(280, 315)))
transmittance(polyester.spct, waveband(c(315, 400)))
transmittance(polyester.spct, waveband(c(400, 700)))
Run the code above in your browser using DataLab