resp_spct: Calculate response from spectral response

Description Usage Arguments Value Note

View source: R/spct.response.R

Description

This function returns the mean response for a given waveband and a response spectrum.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
resp_spct(
  spct,
  w.band,
  unit.out,
  quantity,
  time.unit,
  scale.factor,
  wb.trim,
  use.hinges,
  allow.scaled = !quantity %in% c("average", "mean", "total"),
  naming,
  ...
)

Arguments

spct

an object of class response_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.

unit.out

character with allowed values "energy", and "photon", or its alias "quantum".

quantity

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

scale.factor

numeric vector of length 1, or length equal to that of w.band. Numeric multiplier applied to returned values.

wb.trim

logical if TRUE wavebands crossing spectral data boundaries are trimmed, if FALSE, they are discarded.

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 expressed either as a fraction of one or a percentage, or a vector of the same length as the list of waveband objects.

Note

The parameter use.hinges 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 Aug. 28, 2020, 1:11 a.m.