Skip to contents

Convert photon-based quantities into energy-based quantities

Source: R/spct-conversion-qty-unit.R
q2e.Rd

Conversion methods for spectral photon irradiance into spectral energy irradiance and for spectral photon response into spectral energy response.

Usage

q2e(x, action, byref, ...)

# Default S3 method
q2e(x, action = "add", byref = FALSE, ...)

# S3 method for class 'source_spct'
q2e(x, action = "add", byref = FALSE, ...)

# S3 method for class 'response_spct'
q2e(x, action = "add", byref = FALSE, ...)

# S3 method for class 'source_mspct'
q2e(x, action = "add", byref = FALSE, ..., .parallel = FALSE, .paropts = NULL)

# S3 method for class 'response_mspct'
q2e(x, action = "add", byref = FALSE, ..., .parallel = FALSE, .paropts = NULL)

Arguments

x

an R object.

action

a character string, one of "add", or "replace".

byref

logical indicating if a new object will be created by reference or a new object returned.

...

not used in current version.

.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.

Details

The converted spectral values are added to or replace the existing spectral values depending on the argument passed to parameter action. Addition is currently not supported for normalized spectra. If the spectrum has been normalized with a recent version of package 'photobiology' the spectrum will be renormalized after conversion using the same arguments as previously.

Methods (by class)

  • q2e(default): Default method

  • q2e(source_spct): Method for spectral irradiance

  • q2e(response_spct): Method for spectral responsiveness

  • q2e(source_mspct): Method for collections of (light) source spectra

  • q2e(response_mspct): Method for collections of response spectra

See also

Other quantity conversion functions: A2T(), Afr2T(), T2A(), T2Afr(), any2T(), as_quantum(), e2q(), e2qmol_multipliers(), e2quantum_multipliers()