fluence: Fluence

Description

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

Usage

fluence(
  spct,
  w.band,
  unit.out,
  exposure.time,
  scale.factor,
  wb.trim,
  use.cached.mult,
  use.hinges,
  allow.scaled,
  ...
)
# S3 method for default
fluence(
  spct,
  w.band,
  unit.out,
  exposure.time,
  scale.factor,
  wb.trim,
  use.cached.mult,
  use.hinges,
  allow.scaled,
  ...
)
# S3 method for source_spct
fluence(
  spct,
  w.band = NULL,
  unit.out = getOption("photobiology.radiation.unit", default = "energy"),
  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
fluence(
  spct,
  w.band = NULL,
  unit.out = getOption("photobiology.radiation.unit", default = "energy"),
  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",
  ...,
  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 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] If time.unit is day, [J d-1 m-2 nm-1] -> [mol d-1 m-2]

Arguments

spct: an R object.
w.band: a list of waveband objects or a waveband object.
unit.out: character string with allowed values "energy", and "photon", or its alias "quantum".
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 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 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)

fluence(default): Default for generic function
fluence(source_spct): Calculate photon fluence from a source_spct object and the duration of the exposure
fluence(source_mspct): Calculates fluence from a source_mspct object.

Examples

Run this code

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