This function returns the photon ratio for a given pair of wavebands of a light source spectrum.
e_ratio(
spct,
w.band.num,
w.band.denom,
scale.factor,
wb.trim,
use.cached.mult,
use.hinges,
...
)# S3 method for default
e_ratio(
spct,
w.band.num,
w.band.denom,
scale.factor,
wb.trim,
use.cached.mult,
use.hinges,
...
)
# S3 method for source_spct
e_ratio(
spct,
w.band.num = NULL,
w.band.denom = NULL,
scale.factor = 1,
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.cached.mult = FALSE,
use.hinges = NULL,
quantity = "total",
naming = "short",
name.tag = NULL,
...
)
# S3 method for source_mspct
e_ratio(
spct,
w.band.num = NULL,
w.band.denom = NULL,
scale.factor = 1,
wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
use.cached.mult = FALSE,
use.hinges = NULL,
quantity = "total",
naming = "short",
name.tag = ifelse(naming != "none", "[e:e]", ""),
...,
attr2tb = NULL,
idx = "spct.idx",
.parallel = FALSE,
.paropts = NULL
)
In the case of methods for individual spectra, a numeric
vector with name attribute set. The name is based on the name of the
wavebands unless a named list of wavebands is supplied in which case the
names of the list elements are used. "[e:e]" is appended if quantity
= "total" and "[e(wl):e(wl)]" if quantity = "mean" or
quantity = "average".
A data.frame is returned in the case of collections of spectra,
containing one column for each fraction definition, an index column with
the names of the spectra, and optionally additional columns with metadata
values retrieved from the attributes of the member spectra.
source_spct
waveband object or a list of waveband objects used to compute the numerator(s) of the ratio(s).
waveband object or a list of waveband objects used to compute the denominator(s) of the ratio(s).
numeric vector of length 1, or length equal to that of
w.band. Numeric multiplier applied to returned values.
logical if TRUE wavebands crossing spectral data boundaries are trimmed, if FALSE, they are discarded
logical Flag telling 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.
other arguments (possibly used by derived methods).
character One of "total", "average" or "mean".
character one of "long", "default", "short" or "none". Used to select the type of names to assign to returned value.
character Used to tag the name of the returned values.
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.
e_ratio(default): Default for generic function
e_ratio(source_spct): Method for source_spct objects
e_ratio(source_mspct): Calculates energy:energy ratio from a source_mspct
object.
As this method accepts spectra as its input, it computes irradiances before computing the ratios. If you need to compute both ratios and irradiances from several hundreds or thousands of spectra, computing the ratios from previously computed irradiances avoids their repeated computation. A less dramatic, but still important, increase in performance is available when computing in the same function call ratios that share the same denominator.
With the default quantity = "total" the ratio is based on
two energy irradiances, one computed for each waveband.
$$\frac{I(s, wb_\mathrm{num})}{I(s, wb_\mathrm{denom})}$$
If the argument is set to quantity = "mean" or
quantity = "average" the ratio is based on
two mean spectral photon irradiances, one computed for each waveband.
$$\frac{\overline{I_\lambda}(s, wb_\mathrm{num})}{\overline{I_\lambda}(s, wb_\mathrm{denom})}$$
Only if the wavelength expanse of the two wavebands is the same, these two ratios are numerically identical.
Fraction definitions are "assembled" from the arguments passed to
w.band.num and w.band.denom. If both arguments are lists of
waveband definitions, with an equal number of members, then the wavebands
are paired to obtain as many fractions as the number of wavebands in each
list. Recycling for wavebands takes place when the number of denominator
and numerator wavebands differ.
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 photon and energy ratio functions:
e_fraction(),
eq_ratio(),
q_fraction(),
q_ratio(),
qe_ratio()
e_ratio(sun.spct,
waveband(c(400,500), wb.name = "Blue"),
waveband(c(400,700), wb.name = "White"))
Run the code above in your browser using DataLab