Get the

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, ...)

# Default S3 method
getFilterProperties(x, return.null = FALSE, ...)

# S3 method for class 'filter_spct'
getFilterProperties(x, return.null = FALSE, ...)

# S3 method for class 'summary_filter_spct'
getFilterProperties(x, return.null = FALSE, ...)

# S3 method for class '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" [\(/1\)], "thickness" [\(m\)] 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)

getFilterProperties(default): default
getFilterProperties(filter_spct): generic_spct
getFilterProperties(summary_filter_spct): summary_generic_spct
getFilterProperties(generic_mspct): filter_mspct

Note

The method for collections of spectra returns the a tibble with a column of lists.

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

Examples

filter_properties(polyester.spct)
#> Rfr (/1): 0.074, thickness (mm): 0.125, attenuation mode: absorption.

Get the "filter.properties" attribute