two_irrads: Compute two irrads for ratio, fraction or normalised...

In photobiology: Photobiological Calculations

Compute two irrads for ratio, fraction or normalised difference

Description

Internal function that computes the two irradiances needed to compute various waveband ratios and fractions.

Usage

two_irrads(
  spct,
  w.band.num,
  w.band.denom,
  unit.out.num,
  unit.out.denom,
  quantity,
  wb.trim,
  use.cached.mult,
  use.hinges,
  naming
)

Arguments

spct	an object of class "source_spct".
w.band.num, w.band.denom	waveband objects or lists of waveband objects used to compute the numerator(s) and denominator(s) of the ratio(s). The waveband(s) determine the region(s) of the spectrum that are summarized.
unit.out.num, unit.out.denom	character Allowed values "energy", and "photon", or its alias "quantum".
quantity	character string One of "total", "average" or "mean".
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.
naming	character one of "long", "default", "short" or "none". Used to select the type of names to assign to returned value.

Details

See irrad for details on the irradiance calculations.

photobiology documentation built on Oct. 21, 2023, 1:06 a.m.