normalization: Normalization of an R object

In photobiology: Photobiological Calculations

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)

## Default S3 method:
normalization(x)

## S3 method for class 'waveband'
normalization(x)

## S3 method for class 'generic_spct'
normalization(x)

## S3 method for class 'summary_generic_spct'
normalization(x)

## S3 method for class 'generic_mspct'
normalization(x)

Arguments

x	an R 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.

Value

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

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.

Note

Older versions of the package stored only a subset of the metadata or only a flag to indicate that normalization had been applied. For such objects some or even all fields in the returned list are set to NA.

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)

photobiology documentation built on April 4, 2025, 4:37 a.m.