Get the

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

Usage

getHowMeasured(x, ...)

how_measured(x, ...)

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

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

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

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

# S3 method for class 'generic_mspct'
getHowMeasured(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)

getHowMeasured(default): default
getHowMeasured(generic_spct): generic_spct
getHowMeasured(summary_generic_spct): summary_generic_spct
getHowMeasured(data.frame): data.frame
getHowMeasured(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(), 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

how_measured(sun.spct)
#> [1] "Simulated using 'libRadtran'. Average for one hour, centred approximately on local solar noon."

Get the "how.measured" attribute