transmittance_spct: Calculate transmittance from spectral transmittance.

View source: R/spct.transmittance.r

transmittance_spctR Documentation

Calculate transmittance from spectral transmittance.

Description

Mean transmittance for one or more wavebands of a filter or object spectrum.

Usage

transmittance_spct(spct, w.band, quantity, wb.trim, use.hinges, naming, ...)

Arguments

spct

an object of class "generic_spct".

w.band

waveband or list of waveband objects or a numeric vector of length two. The waveband(s) determine the region(s) of the spectrum that are summarized. If a numeric range is supplied a waveband object is constructed on the fly from it.

quantity

character string One of "total", "average" or "mean", "contribution", "contribution.pc", "relative" or "relative.pc".

wb.trim

logical Flag indicating if wavebands crossing spectral data boundaries are trimmed or ignored.

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.

...

other arguments (possibly used by derived methods).

Value

a single numeric value

Note

The last parameter controls speed optimization. The defaults should be suitable in most cases. Only the range of wavelengths in the wavebands is used and all BSWFs are ignored.


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