photobiology (version 0.9.6)

q_response: Photon-based photo-response

Description

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

Usage

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

## S3 method for class 'default':
q_response(spct, w.band, quantity, time.unit, wb.trim,
  use.hinges, ...)

## S3 method for class 'response_spct':
q_response(spct, w.band = NULL, 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':
q_response(spct, w.band = NULL, quantity = "total",
  time.unit = NULL, wb.trim = getOption("photobiology.waveband.trim",
  default = TRUE), use.hinges = getOption("photobiology.use.hinges", default =
  NULL), ..., idx = !is.null(names(spct)))

Arguments

spct

an R object

w.band

a waveband object or a list of waveband objects

quantity

character

time.unit

character or lubridate::duration

wb.trim

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

use.hinges

logical indicating whether to use hinges to reduce interpolation errors

...

other arguments

idx

logical whether to add a column with the names of the elements of spct

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 wave.bands. The quantity returned, although always on photon-based units, depends on the value of quantity.

Methods (by class)

• default: Default method for generic function
• response_spct: Method for response spectra.
• response_mspct: Calculates photon (quantum) response from aresponse_mspct

See Also

Other response functions: e_response, response

Examples

q_response(ccd.spct, new_waveband(200,300))
q_response(photodiode.spct)