
This function returns the irradiance for a given waveband of a light source spectrum.
irrad(spct, w.band, unit.out, quantity, time.unit, wb.trim, use.cached.mult,
use.hinges, allow.scaled, ...)# S3 method for default
irrad(spct, w.band, unit.out, quantity, time.unit, wb.trim,
use.cached.mult, use.hinges, allow.scaled, ...)
# S3 method for source_spct
irrad(spct, w.band = NULL,
unit.out = getOption("photobiology.radiation.unit", default = "energy"),
quantity = "total", time.unit = NULL,
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.cached.mult = getOption("photobiology.use.cached.mult", default =
FALSE), use.hinges = getOption("photobiology.use.hinges"),
allow.scaled = !quantity %in% c("average", "mean", "total"), ...)
# S3 method for source_mspct
irrad(spct, w.band = NULL,
unit.out = getOption("photobiology.radiation.unit", default = "energy"),
quantity = "total", time.unit = NULL,
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.cached.mult = getOption("photobiology.use.cached.mult", default =
FALSE), use.hinges = NULL, allow.scaled = !quantity %in% c("average",
"mean", "total"), ..., attr2tb = NULL, idx = !is.null(names(spct)),
.parallel = FALSE, .paropts = NULL)
an R object.
waveband or list of waveband objects The waveband(s) determine the region(s) of the spectrum that are summarized.
character string with allowed values "energy", and "photon", or its alias "quantum".
character string One of "total", "average" or "mean", "contribution", "contribution.pc", "relative" or "relative.pc".
character or lubridate::duration object.
logical if TRUE wavebands crossing spectral data boundaries are trimmed, if FALSE, they are discarded.
logical indicating whether multiplier values should be cached between calls.
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.
logical indicating whether scaled or normalized spectra as argument to spct are flagged as an error
other arguments (possibly ignored)
character vector, see add_attr2tb
for the syntax for attr2tb
passed as is to formal parameter col.names
.
logical whether to add a column with the names of the elements of spct
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.
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. The time.unit
attribute is copied from the spectrum object to the output. Units are as
follows: If time.unit is second, [W m-2 nm-1] -> [mol s-1 m-2] or [W m-2
nm-1] -> [W m-2] If time.unit is day, [J d-1 m-2 nm-1] -> [mol d-1 m-2] or
[J d-1 m-2 nm-1] -> [J m-2]
default
: Default for generic function
source_spct
: Calculates irradiance from a source_spct
object.
source_mspct
: Calculates irradiance from a source_mspct
object.
Other irradiance functions: e_fluence
,
e_irrad
, fluence
,
q_fluence
, q_irrad
# NOT RUN {
irrad(sun.spct, waveband(c(400,700)))
irrad(sun.spct, waveband(c(400,700)), "energy")
irrad(sun.spct, waveband(c(400,700)), "photon")
irrad(sun.spct, split_bands(c(400,700), length.out = 3))
irrad(sun.spct, split_bands(c(400,700), length.out = 3), quantity = "total")
irrad(sun.spct, split_bands(c(400,700), length.out = 3), quantity = "average")
irrad(sun.spct, split_bands(c(400,700), length.out = 3), quantity = "relative")
irrad(sun.spct, split_bands(c(400,700), length.out = 3), quantity = "relative.pc")
irrad(sun.spct, split_bands(c(400,700), length.out = 3), quantity = "contribution")
irrad(sun.spct, split_bands(c(400,700), length.out = 3), quantity = "contribution.pc")
# }
Run the code above in your browser using DataLab