getWhatMeasured: Get the '"what.measured"' attribute

In photobiology: Photobiological Calculations

Get the "what.measured" attribute

Description

Method to read the "what.measured" attribute of an R 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	an R 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. If x does not belong to a supported class NA is returned.

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 data.frame with a column of character strings.

See Also

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

my.spct <- sun.spct
what_measured(my.spct)
what_measured(my.spct) <- "Sun"
what_measured(my.spct)
what_measured(my.spct) <- NULL
what_measured(my.spct)

photobiology documentation built on June 8, 2025, 10:14 a.m.