e_irrad | R Documentation |
Energy irradiance for one or more wavebands of a light source spectrum.
e_irrad(
spct,
w.band,
quantity,
time.unit,
scale.factor,
wb.trim,
use.cached.mult,
use.hinges,
allow.scaled,
...
)
## Default S3 method:
e_irrad(
spct,
w.band,
quantity,
time.unit,
scale.factor,
wb.trim,
use.cached.mult,
use.hinges,
allow.scaled,
...
)
## S3 method for class 'source_spct'
e_irrad(
spct,
w.band = NULL,
quantity = "total",
time.unit = NULL,
scale.factor = 1,
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"),
naming = "default",
...
)
## S3 method for class 'source_mspct'
e_irrad(
spct,
w.band = NULL,
quantity = "total",
time.unit = NULL,
scale.factor = 1,
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"),
naming = "default",
...,
attr2tb = NULL,
idx = "spct.idx",
.parallel = FALSE,
.paropts = NULL
)
spct |
an R object. |
w.band |
a list of |
quantity |
character string One of "total", "average" or "mean", "contribution", "contribution.pc", "relative" or "relative.pc". |
time.unit |
character or lubridate::duration object. |
scale.factor |
numeric vector of length 1, or length equal to that of
|
wb.trim |
logical if TRUE wavebands crossing spectral data boundaries are trimmed, if FALSE, they are discarded. |
use.cached.mult |
logical indicating whether multiplier values should be cached between calls. |
use.hinges |
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. |
allow.scaled |
logical indicating whether scaled or normalized spectra as argument to spct are flagged as an error. |
... |
other arguments (possibly used by derived methods). |
naming |
character one of "long", "default", "short" or "none". Used to select the type of names to assign to returned value. |
attr2tb |
character vector, see |
idx |
character Name of the column with the names of the members of the collection of spectra. |
.parallel |
if TRUE, apply function in parallel, using parallel backend provided by foreach |
.paropts |
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 units are absolute and time.unit is second, [W m-2 nm-1] -> [W
m-2] If time.unit is day, [J d-1 m-2 nm-1] -> [J m-2]; if units are
relative, fraction of one or percent.
e_irrad(default)
: Default for generic function
e_irrad(source_spct)
: Calculates energy irradiance from a source_spct
object.
e_irrad(source_mspct)
: Calculates energy irradiance from a
source_mspct
object.
The last two parameters control speed optimizations. The defaults
should be suitable in most cases. If you will use repeatedly the same SWFs
on many spectra measured at exactly the same wavelengths you may obtain
some speed up by setting use.cached.mult=TRUE
. However, be aware
that you are responsible for ensuring that the wavelengths are the same in
each call, as the only test done is for the length of the w.length
vector.
Other irradiance functions:
e_fluence()
,
fluence()
,
irrad()
,
q_fluence()
,
q_irrad()
e_irrad(sun.spct, waveband(c(400,700)))
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3))
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3),
quantity = "total")
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3),
quantity = "average")
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3),
quantity = "relative")
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3),
quantity = "relative.pc")
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3),
quantity = "contribution")
e_irrad(sun.spct, split_bands(c(400,700), length.out = 3),
quantity = "contribution.pc")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.