photobiology (version 0.11.4)

e_fraction: Energy:energy fraction

Description

This function returns the energy fraction for a given pair of wavebands of a light source spectrum.

Usage

e_fraction(
  spct,
  w.band.num,
  w.band.denom,
  scale.factor,
  wb.trim,
  use.cached.mult,
  use.hinges,
  ...
)
# S3 method for default
e_fraction(
  spct,
  w.band.num,
  w.band.denom,
  scale.factor,
  wb.trim,
  use.cached.mult,
  use.hinges,
  ...
)
# S3 method for source_spct
e_fraction(
  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_fraction(
  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
)

Value

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.

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.

Arguments

spct

source_spct

w.band.num

waveband object or a list of waveband objects used to compute the numerator(s) and denominator(s) of the fraction(s).

w.band.denom

waveband object or a list of waveband objects used to compute the denominator(s) of the fraction(s).

scale.factor

numeric vector of length 1, or length equal to that of w.band. Numeric multiplier applied to returned values.

wb.trim

logical if TRUE wavebands crossing spectral data boundaries are trimmed, if FALSE, they are discarded

use.cached.mult

logical Flag telling 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.

...

other arguments (possibly used by derived methods).

quantity

character One of "total", "average" or "mean".

naming

character one of "long", "default", "short" or "none". Used to select the type of names to assign to returned value.

name.tag

character Used to tag the name of the returned values.

attr2tb

character vector, see add_attr2tb for the syntax for attr2tb passed as is to formal parameter col.names.

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.

Methods (by class)

• e_fraction(default): Default for generic function

• e_fraction(source_spct): Method for source_spct objects

• e_fraction(source_mspct): Calculates energy:energy fraction from a source_mspct object.

Details

With the default quantity = "total" the fraction is based on two energy irradiances, one computed for each waveband.

$$\frac{E(s, wb_\mathrm{num})}{E(s, wb_\mathrm{denom}) + E(s, wb_\mathrm{num})}$$

If the argument is set to quantity = "mean" or quantity = "average" the ratio is based on two mean spectral energy irradiances, one computed for each waveband.

$$\frac{\overline{Q_\lambda}(s, wb_\mathrm{num})}{\overline{Q_\lambda}(s, wb_\mathrm{denom}) + \overline{Q_\lambda}(s, wb_\mathrm{num})}$$

Only if the wavelength expanse of the two wavebands is the same, these two ratios are numerically identical.

See Also

Other photon and energy ratio functions: e_ratio(), eq_ratio(), q_fraction(), q_ratio(), qe_ratio()

Examples

e_fraction(sun.spct, new_waveband(400,700), new_waveband(400,500))