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.
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)
#> [1] "instr_desc" "list"
print(valid.descriptor)
#> Data acquired with 'MayaPro2000' s.n. MAYP11278
#> grating 'HC1', slit '010s'
#> diffuser 'unknown'
print(str(valid.descriptor))
#> List of 13
#> $ time : POSIXct[1:1], format: "2016-11-02 16:34:05"
#> $ sr.index : int 0
#> $ ch.index : int 0
#> $ spectrometer.name: chr "MayaPro2000"
#> $ spectrometer.sn : chr "MAYP11278"
#> $ bench.grating : chr "HC1"
#> $ bench.filter : chr "000"
#> $ bench.slit : chr "010s"
#> $ min.integ.time : int 7200
#> $ max.integ.time : int 7200000
#> $ max.counts : int 64000
#> $ wavelengths : num [1:2068] 188 188 189 189 190 ...
#> $ bad.pixs : int [1:4] 123 380 1829 1994
#> - attr(*, "class")= chr [1:2] "instr_desc" "list"
#> NULL
missing.descriptor <- getInstrDesc(white_body.spct)
class(missing.descriptor)
#> [1] "instr_desc" "list"
print(missing.descriptor)
#> Data acquired with 'NA' s.n. NA
#> grating 'NA', slit 'NA'
#> diffuser 'unknown'
print(str(missing.descriptor))
#> List of 4
#> $ spectrometer.name: chr NA
#> $ spectrometer.sn : chr NA
#> $ bench.grating : chr NA
#> $ bench.slit : chr NA
#> - attr(*, "class")= chr [1:2] "instr_desc" "list"
#> NULL