RLum.Data.Spectrum-class
Class "RLum.Data.Spectrum"
Class for representing luminescence spectra data (TL/OSL/RF).
Usage
# S4 method for RLum.Data.Spectrum
show(object)# S4 method for RLum.Data.Spectrum
set_RLum(class, originator, .uid, .pid,
recordType = "Spectrum", curveType = NA_character_,
data = matrix(), info = list())
# S4 method for RLum.Data.Spectrum
get_RLum(object, info.object)
# S4 method for RLum.Data.Spectrum
names_RLum(object)
Arguments
- object
get_RLum,names_RLum(required): an object of class '>RLum.Data.Spectrum- class
set_RLum; character (automatic): name of theRLumclass to create.- originator
character (automatic): contains the name of the calling function (the function that produces this object); can be set manually.
- .uid
set_RLum; character (automatic): sets an unique ID for this object using the internal C++ functioncreate_UID.- .pid
set_RLum; character (with default): option to provide a parent id for nesting at will.- recordType
- curveType
set_RLum; character: curve type (e.g. "predefined" or "measured")- data
set_RLum; matrix: raw curve data. If data is of typeRLum.Data.Spectrum, this can be used to re-construct the object.- info
- info.object
get_RLum; character (optional): the name of the info object to be called
Value
[set_RLum]
An object from the class RLum.Data.Spectrum
get_RLum
A matrix with the spectrum values or
only the info object if
info.objectwas set.
names_RLum
The names of the info objects
Note
The class should only contain data for a single spectra data set. For
additional elements the slot info can be used. Objects from this class are automatically
created by, e.g., read_XSYG2R
Methods (by generic)
show: Show structure ofRLum.Data.Spectrumobjectset_RLum: Construction method for RLum.Data.Spectrum object. The slot info is optional and predefined as empty list by defaultget_RLum: Accessor method for RLum.Data.Spectrum object. The argument info.object is optional to directly access the info elements. If no info element name is provided, the raw curve data (matrix) will be returnednames_RLum: Returns the names info elements coming along with this curve object
Slots
recordTypeObject of class character containing the type of the curve (e.g. "TL" or "OSL")
curveTypeObject of class character containing curve type, allowed values are measured or predefined
dataObject of class matrix containing spectrum (count) values. Row labels indicate wavelength/pixel values, column labels are temperature or time values.
infoObject of class list containing further meta information objects
Objects from the Class
Objects can be created by calls of the form set_RLum("RLum.Data.Spectrum", ...).
Class version
0.4.0
How to cite
Kreutzer, S. (2018). RLum.Data.Spectrum-class(): Class 'RLum.Data.Spectrum'. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J. (2018). Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.8.6. https://CRAN.R-project.org/package=Luminescence
See Also
'>RLum, '>RLum.Data, plot_RLum
Examples
# NOT RUN {
showClass("RLum.Data.Spectrum")
##show example data
data(ExampleData.XSYG, envir = environment())
TL.Spectrum
##show data matrix
get_RLum(TL.Spectrum)
##plot spectrum
# }
# NOT RUN {
plot_RLum(TL.Spectrum)
# }
# NOT RUN {
# }