photobiology (version 0.10.6)

getFilterProperties: Get the "filter.properties" attribute

Description

Function to read the "filter.properties" attribute of an existing filter_spct or a filter_mspct.

Usage

getFilterProperties(x, return.null, ...)
filter_properties(x, return.null, ...)
# S3 method for default
getFilterProperties(x, return.null = FALSE, ...)
# S3 method for filter_spct
getFilterProperties(x, return.null = FALSE, ...)
# S3 method for summary_filter_spct
getFilterProperties(x, return.null = FALSE, ...)
# S3 method for generic_mspct
getFilterProperties(x, return.null = FALSE, ..., idx = "spct.idx")

Arguments

x

a filter_spct object

return.null

logical If true, NULL is returned if the attribute is not set, otherwise the expected list is returned with all fields set to NA.

...

Allows use of additional arguments in methods for other classes.

idx

character Name of the column with the names of the members of the collection of spectra.

Value

a list with fields named "Rfr.constant", "thickness" and "attenuation.mode". If the attribute is not set, and return.null is FALSE, a list with fields set to NA is returned, otherwise, NULL.

Methods (by class)

• default: default

• filter_spct: generic_spct

• summary_filter_spct: summary_generic_spct

• generic_mspct: filter_mspct

See Also

Other measurement metadata functions: add_attr2tb(), getHowMeasured(), getInstrDesc(), getInstrSettings(), getWhatMeasured(), getWhenMeasured(), getWhereMeasured(), get_attributes(), isValidInstrDesc(), isValidInstrSettings(), select_spct_attributes(), setFilterProperties(), setHowMeasured(), setInstrDesc(), setInstrSettings(), setWhatMeasured(), setWhenMeasured(), setWhereMeasured(), spct_attr2tb(), spct_metadata(), trimInstrDesc(), trimInstrSettings()

Examples

# NOT RUN {
filter_properties(polyester.spct)

# }