R: Integrated response

response {photobiology} | R Documentation

## Integrated response

### Description

Calculate average photon- or energy-based photo-response.

### Usage

    response(spct, w.band, unit.out, quantity, time.unit, wb.trim, use.hinges, ...)

    ## Default S3 method:
    response(spct, w.band, unit.out, quantity, time.unit, wb.trim,
      use.hinges, ...)

    ## S3 method for class 'response_spct'
    response(spct, w.band = NULL,
      unit.out = getOption("photobiology.radiation.unit", default = "energy"),
      quantity = "total", time.unit = NULL,
      wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
      use.hinges = getOption("photobiology.use.hinges", default = NULL), ...)

    ## S3 method for class 'response_mspct'
    response(spct, w.band = NULL,
      unit.out = getOption("photobiology.radiation.unit", default = "energy"),
      quantity = "total", time.unit = NULL,
      wb.trim = getOption("photobiology.waveband.trim", default = TRUE),
      use.hinges = getOption("photobiology.use.hinges", default = NULL), ...,
      attr2tb = NULL, idx = !is.null(names(spct)), .parallel = FALSE,
      .paropts = NULL)

### Arguments

`spct` | an R 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.
`unit.out` | character 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".
`time.unit` | character or lubridate::duration object.
`wb.trim` | logical Flag telling 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.
`...` | other arguments (possibly used by derived methods).
`attr2tb` | character vector, see `add_attr2tb` for the syntax for `attr2tb` passed as is to formal parameter `col.names`.
`idx` | logical whether to add a column with the names of the elements of spct
`.parallel` | if TRUE, apply function in parallel, using parallel backend provided by foreach
`.paropts` | a list of additional options passed into the foreach function when parallel computation is enabled. This is important if (for example) your code relies on external data or packages: use the .export and .packages arguments to supply them so that all cluster nodes have the correct environment set up for computing.

### Value

A named `numeric` vector in the case of methods for individual spectra, with one value for each `waveband` passed to parameter `w.band`. A `data.frame` in the case of collections of spectra, containing one column for each `waveband` object, an index column with the names of the spectra, and optionally additional columns with metadata values retrieved from the attributes of the member spectra.

Whether returned values are expressed in energy-based or photon-based units depends on `unit.out`. By default values are only integrated, but depending on the argument passed to parameter `quantity` they can be re-expressed as relative fractions or percentages. In the case of vector output, `names` attribute is set to the name of the corresponding waveband unless a named list is supplied in which case the names of the list members are used.

### Methods (by class)

- `default`: Default for generic function

- `response_spct`: Method for response spectra.

- `response_mspct`: Calculates response from a `response_mspct`

### 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.

### See Also

Other response functions: `e_response`, `q_response`

[Package photobiology version 0.9.21 Index]