Learn R Programming

photobiology (version 0.11.3)

two_transmittances: Compute two transmittances for ratio, fraction or normalised difference

Description

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

Usage

two_transmittances(
  spct,
  w.band.1,
  w.band.2,
  quantity,
  wb.trim,
  use.cached.mult,
  use.hinges,
  naming
)

Arguments

spct

an object of class "filter_spct" or "object_spct".

w.band.1, w.band.2

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.

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 transmittance for details on the transmittance calculations.