setResponseType: Set the "response.type" attribute

View source: R/spct.classes.r

setResponseTypeR Documentation

Set the "response.type" attribute

Description

Functions to set by reference the "response.type" attribute of an existing response_spct object, and to query its value.

Usage

setResponseType(x, response.type = c("response", "action"))

getResponseType(x)

Arguments

x

a response_spct object

response.type

a character string, either "response" or "action"

Details

Objects of class response_spct() can contain data for a response spectrum or an action spectrum. Response spectra are measured using the same photon (or energy) irradiance at each wavelength. Action spectra are derived from dose response curves at each wavelength, and responsivity at each wavelength is expressed as the reciprocal of the photon fluence required to obtain a fixed level of response. In the case of biological systems the action and response spectra frequently differ in their shape and spectral values. This is a property inherent to a data set and not subject to conversions, thus normally set when a response_spct object is created and never modified.

Value

x

Note

This function alters x itself by reference and in addition returns x invisibly. If x is not a response_spct object, x is not modified The behaviour of this function is 'unusual' in that the default for parameter response.type is used only if x does not already have this attribute set.

Examples

my.spct <- ccd.spct
setResponseType(my.spct, "action")
getResponseType(ccd.spct)
getResponseType(sun.spct)


aphalo/photobiology documentation built on April 1, 2024, 6:48 p.m.