convertThickness: Convert the "thickness" attribute of an existing filter_spct...

View source: R/spct.classes.r

convertThicknessR Documentation

Convert the "thickness" attribute of an existing filter_spct object.

Description

Function to set the "thickness" attribute and simultaneously converting the spectral data to correspond to the new thickness.

Usage

convertThickness(x, thickness = NULL)

Arguments

x

a filter_spct, object_spct, filter_mspct or object_mspct object.

thickness

numeric [m].

Details

For spectral transmittance at a different thickness to be exactly computed, it needs to be based on internal transmittance. This function will apply converTfrType() to x if needed, but to succeed metadata should be available. Please, see convertTfrType.

Value

x possibly with the "thickness" field of the "filter.properties" attribute modified and Tfr or A computed for the requested thickness.

Note

if x is not a filter_spct, object_spct, filter_mspct or object_mspct object or a collection of such objects, x is returned unchanged. If x does not have the "filter.properties" attribute set or has it with missing member data, x is returned with Tfr set to NA values.

See Also

Other time attribute functions: checkTimeUnit(), convertTimeUnit(), getTimeUnit(), setTimeUnit()

Examples


my.spct <- polyester.spct
filter_properties(my.spct)
convertThickness(my.spct, thickness = 250e-6)


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