RLum.Data.Spectrum-class

0th

Percentile

Class "RLum.Data.Spectrum"

Class for representing luminescence spectra data (TL/OSL/RF).

Keywords
classes, internal
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 the RLum class 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++ function create_UID.

.pid

set_RLum; character (with default): option to provide a parent id for nesting at will.

recordType

set_RLum; character: record type (e.g. "OSL")

curveType

set_RLum; character: curve type (e.g. "predefined" or "measured")

data

set_RLum; matrix: raw curve data. If data is of type RLum.Data.Spectrum, this can be used to re-construct the object.

info

set_RLum list: info elements

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

  1. A matrix with the spectrum values or

  2. only the info object if info.object was 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 of RLum.Data.Spectrum object

  • set_RLum: Construction method for RLum.Data.Spectrum object. The slot info is optional and predefined as empty list by default

  • get_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 returned

  • names_RLum: Returns the names info elements coming along with this curve object

Slots

recordType

Object of class character containing the type of the curve (e.g. "TL" or "OSL")

curveType

Object of class character containing curve type, allowed values are measured or predefined

data

Object of class matrix containing spectrum (count) values. Row labels indicate wavelength/pixel values, column labels are temperature or time values.

info

Object 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

Aliases
  • RLum.Data.Spectrum-class
  • show,RLum.Data.Spectrum-method
  • set_RLum,RLum.Data.Spectrum-method
  • get_RLum,RLum.Data.Spectrum-method
  • names_RLum,RLum.Data.Spectrum-method
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 {
# }
Documentation reproduced from package Luminescence, version 0.8.6, License: GPL-3

Community examples

Looks like there are no examples yet.