e_fluence: Energy fluence

Description

Energy fluence for one or more wavebands of a light source spectrum and a duration of the exposure.

Usage

e_fluence(
  spct,
  w.band,
  exposure.time,
  scale.factor,
  wb.trim,
  use.cached.mult,
  use.hinges,
  allow.scaled,
  ...
)
# S3 method for default
e_fluence(
  spct,
  w.band,
  exposure.time,
  scale.factor,
  wb.trim,
  use.cached.mult,
  use.hinges,
  allow.scaled,
  ...
)
# S3 method for source_spct
e_fluence(
  spct,
  w.band = NULL,
  exposure.time,
  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 = FALSE,
  naming = "default",
  ...
)
# S3 method for source_mspct
e_fluence(
  spct,
  w.band = NULL,
  exposure.time,
  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 = FALSE,
  ...,
  attr2tb = NULL,
  idx = "spct.idx",
  .parallel = FALSE,
  .paropts = NULL
)

Value

One numeric value for each waveband with no change in scale factor, with name attribute set to the name of each waveband unless a named list is supplied in which case the names of the list elements are used. The exposure.time is copied to the output as an attribute. Units are as follows: (J) joules per exposure.

Arguments

spct: an R object
w.band: a list of waveband objects or a waveband object
exposure.time: lubridate::duration object.
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 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 ignored)
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 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_fluence(default): Default for generic function
e_fluence(source_spct): Calculate energy fluence from a source_spct object and the duration of the exposure.
e_fluence(source_mspct): Calculates energy fluence from a source_mspct object.

Examples

Run this code

library(lubridate)
e_fluence(sun.spct, w.band = waveband(c(400,700)),
          exposure.time = lubridate::duration(3, "minutes") )