Get the

Function to read the "what.measured" attribute of an existing generic_spct, generic_mspct, summary_generic_spct, data.frame or a derived-class object.

Usage

getWhatMeasured(x, ...)

what_measured(x, ...)

# Default S3 method
getWhatMeasured(x, ...)

# S3 method for class 'generic_spct'
getWhatMeasured(x, ..., simplify = FALSE)

# S3 method for class 'summary_generic_spct'
getWhatMeasured(x, ..., simplify = FALSE)

# S3 method for class 'data.frame'
getWhatMeasured(x, ..., simplify = FALSE)

# S3 method for class 'generic_mspct'
getWhatMeasured(x, ..., idx = "spct.idx", simplify = FALSE)

Arguments

x: a generic_spct object
...: Allows use of additional arguments in methods for other classes.
simplify: logical If all members share the same attribute value return one copy instead of a data.frame.
idx: character Name of the column with the names of the members of the collection of spectra.

Value

character vector An object containing a description of the data.

Methods (by class)

getWhatMeasured(default): default
getWhatMeasured(generic_spct): generic_spct
getWhatMeasured(summary_generic_spct): summary_generic_spct
getWhatMeasured(data.frame): data.frame
getWhatMeasured(generic_mspct): generic_mspct

Note

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

Other measurement metadata functions: add_attr2tb(), getFilterProperties(), getHowMeasured(), getInstrDesc(), getInstrSettings(), getSoluteProperties(), 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


what_measured(sun.spct)
#> [1] "sunlight, simulated"

Get the "what.measured" attribute