photobiology (version 0.9.16)

eq_ratio: Energy:photon ratio

Description

This function returns the energy to mole of photons ratio for each waveband and a light source spectrum.

Usage

eq_ratio(spct, w.band, wb.trim, use.cached.mult, use.hinges, ...)
# S3 method for default
eq_ratio(spct, w.band, wb.trim, use.cached.mult, use.hinges,
  ...)
# S3 method for source_spct
eq_ratio(spct, w.band = NULL,
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.cached.mult = FALSE,
  use.hinges = getOption("photobiology.use.hinges"), ...)
# S3 method for source_mspct
eq_ratio(spct, w.band = NULL,
  wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
  use.cached.mult = FALSE,
  use.hinges = getOption("photobiology.use.hinges"), ...,
  idx = !is.null(names(spct)))

Arguments

spct

source_spct

w.band

waveband or list of waveband objects

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 telling whether to use hinges to reduce interpolation errors

...

other arguments (possibly ignored)

idx

logical whether to add a column with the names of the elements of spct

Value

a numeric value giving number of Joule per mol of photons for each waveband, with name attribute set to the name of each waveband unless a named list of wavebands is supplied in which case the names of the list elements are used, with "e:q" prepended..

Methods (by class)

• default: Default for generic function

• source_spct: Method for source_spct objects

• source_mspct: Calculates energy:photon from a source_mspct object.

See Also

Other photon and energy ratio functions: e_ratio, energy_ratio, photon_ratio, photons_energy_ratio, q_ratio, qe_ratio

Examples

# NOT RUN {
eq_ratio(sun.spct, new_waveband(400,700))

# }