RLum.Data.Spectrum-class: Class '"RLum.Data.Spectrum"'

Description Usage Arguments Value Methods (by generic) Slots Objects from the Class Class version How to cite Note Author(s) See Also Examples

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
## S4 method for signature 'RLum.Data.Spectrum'
show(object)

## S4 method for signature 'RLum.Data.Spectrum'
set_RLum(
  class,
  originator,
  .uid,
  .pid,
  recordType = "Spectrum",
  curveType = NA_character_,
  data = matrix(),
  info = list()
)

## S4 method for signature 'RLum.Data.Spectrum'
get_RLum(object, info.object)

## S4 method for signature 'RLum.Data.Spectrum'
names_RLum(object)

## S4 method for signature 'RLum.Data.Spectrum'
bin_RLum.Data(object, bin_size.col = 1, bin_size.row = 1)

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. If the object is reconstructed, .uid, .pid and orginator are always taken from the input object

info

set_RLum list: info elements

info.object

get_RLum; character (optional): the name of the info object to be called

bin_size.col

integer (with default): set number of channels used for each bin, e.g. bin_size.col = 2 means that two channels are binned. Note: The function does not check the input, very large values mean a full column binning (a single sum)

bin_size.row

integer (with default): set number of channels used for each bin, e.g. bin_size.row = 2 means that two channels are binned. Note: The function does not check the input, very large values mean a full row binning (a single sum)

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

[bin_RLum.Data]

Same object as input, after applying the binning.

Methods (by generic)

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.5.2

How to cite

Kreutzer, S., 2020. RLum.Data.Spectrum-class(): Class 'RLum.Data.Spectrum'. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., 2020. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.7. https://CRAN.R-project.org/package=Luminescence

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

Author(s)

Sebastian Kreutzer, IRAMAT-CRP2A, UMR 5060, CNRS - Université Bordeaux Montaigne (France) , RLum Developer Team

See Also

RLum, RLum.Data, plot_RLum

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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)

## End(Not run)

R-Lum/Luminescence documentation built on Jan. 4, 2020, 10:44 p.m.