photobiology (version 0.12.0)

normalization: Normalization of an R object

Description

Normalization wavelength [\(nm\)] and other normalization metadata of an R object, retrieved from the object's attributes.

Usage

normalization(x)
# S3 method for default
normalization(x)
# S3 method for waveband
normalization(x)
# S3 method for generic_spct
normalization(x)
# S3 method for summary_generic_spct
normalization(x)
# S3 method for generic_mspct
normalization(x)

Value

A single numeric value of wavelength [\(nm\)] or a list with with members.

Arguments

x

an R object

Methods (by class)

• normalization(default): Default methods.

• normalization(waveband): Normalization of a waveband object.

• normalization(generic_spct): Normalization of a generic_spct object.

• normalization(summary_generic_spct): Normalization of a summary.generic_spct object.

• normalization(generic_mspct): Normalization of a generic_mspct object.

Details

In the case of wavebands for spectral weighting functions (waveband objects), the normalization wavelength is returned. For spectral objects (generic_spct and derived ), the normalization descriptor, a list object, is returned. This list contains in addition to the normalization wavelength, the multiplier used and type of normalization applied. These metadata makes it possible to "undo" the normalization and to "update" the normalization after a transformation, such as conversion to a related physical quantity, of the spectral data.

See Also

Other waveband attributes: is_effective(), labels()

Examples

is_normalized(sun.spct)
normalization(sun.spct)
sun_norm.spct <- normalize(sun.spct)
is_normalized(sun_norm.spct)
normalization(sun_norm.spct)

my_wband <- waveband(c(400,700))
is_normalized(my_wband)
normalization(my_wband)