getInstrDesc: Get the "instr.desc" attribute

In photobiology: Photobiological Calculations

Get the "instr.desc" attribute

Description

Function to query the "instr.desc" attribute of an existing generic_spct or derived-class object, or of a summary_generic_spct or derived-class object.

Usage

getInstrDesc(x)

instr_descriptor(x)

Arguments

x	a generic_spct object or a summary_generic_spct object.

Value

an object of class "instr_desc" derived from "list". The fields spectrometer.name, spectrometer.sn, bench.grating and bench.slit are always present, although may be set to NA. Additional fields can be present depending on the origin of the data.

See Also

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

valid.descriptor <- getInstrDesc(white_led.cps_spct)
class(valid.descriptor)
print(valid.descriptor)
print(str(valid.descriptor))

missing.descriptor <- getInstrDesc(white_body.spct)
class(missing.descriptor)
print(missing.descriptor)
print(str(missing.descriptor))

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