Class for representing luminescence curve data.
# S4 method for RLum.Data.Curve show(object) # S4 method for RLum.Data.Curve set_RLum( class, originator, .uid, .pid, recordType = NA_character_, curveType = NA_character_, data = matrix(0, ncol = 2), info = list() ) # S4 method for RLum.Data.Curve get_RLum(object, info.object = NULL) # S4 method for RLum.Data.Curve length_RLum(object) # S4 method for RLum.Data.Curve names_RLum(object) # S4 method for RLum.Data.Curve bin_RLum.Data(object, bin_size = 2) # S4 method for RLum.Data.Curve smooth_RLum(object, k = NULL, fill = NA, align = "right", method = "mean")
object |
|
---|---|
class |
|
originator |
|
.uid |
|
.pid |
|
recordType | |
curveType |
|
data |
|
info | |
info.object |
|
bin_size | integer (with default):
set number of channels used for each bin, e.g. |
k |
|
fill |
|
align |
|
method |
|
set_RLum
Returns an RLum.Data.Curve object.
get_RLum
A matrix with the curve values or
only the info object if info.object
was set.
length_RLum
Number of channels in the curve (row number of the matrix)
**`names_RLum`**
Names of the info elements (slot `info`)
bin_RLum.Data
Same object as input, after applying the binning.
smooth_RLum
Same object as input, after smoothing
show
: Show structure of RLum.Data.Curve
object
set_RLum
: Construction method for RLum.Data.Curve object. The slot info is optional
and predefined as empty list by default.
get_RLum
: Accessor method for RLum.Data.Curve 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.
length_RLum
: Returns the length of the curve object, which is the maximum of the
value time/temperature of the curve (corresponding to the stimulation length)
names_RLum
: Returns the names info elements coming along with this curve object
bin_RLum.Data
: Allows binning of specific objects
smooth_RLum
: Smoothing of RLum.Data.Curve objects using the function zoo::rollmean or zoo::rollmedian.
In particular the internal function .smoothing
is used.
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 curve x and y data.
'data' can also be of type RLum.Data.Curve
to change object values without
deconstructing the object. For example:
set_RLum(class = 'RLum.Data.Curve', data = Your.RLum.Data.Curve, recordType = 'never seen before')would just change the
recordType
. Missing arguments the value is taken
from the input object in 'data' (which is already an RLum.Data.Curve object
in this example)The class should only contain data for a single curve. For additional
elements the slot info
can be used (e.g. providing additional heating
ramp curve). Objects from the class RLum.Data.Curve
are produced by other
functions (partly within RLum.Analysis objects),
namely: Risoe.BINfileData2RLum.Analysis, read_XSYG2R
Objects can be created by calls of the form
set_RLum(class = "RLum.Data.Curve", ...)
.
0.5.1
Sebastian Kreutzer, IRAMAT-CRP2A, UMR 5060, CNRS - Université Bordeaux Montaigne (France) , RLum Developer Team
Kreutzer, S., 2021. RLum.Data.Curve-class(): Class 'RLum.Data.Curve'. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., Mercier, N., Riedesel, S., Autzen, M., Mittelstrass, D., Gray, H.J., 2021. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.11. https://CRAN.R-project.org/package=Luminescence
showClass("RLum.Data.Curve")#> Class "RLum.Data.Curve" [package "Luminescence"] #> #> Slots: #> #> Name: recordType curveType data originator info .uid #> Class: character character matrix character list character #> #> Name: .pid #> Class: character #> #> Extends: #> Class "RLum.Data", directly #> Class "RLum", by class "RLum.Data", distance 2#> #> [RLum.Data.Curve-class] #> recordType: NA #> curveType: NA #> measured values: 1 #> .. range of x-values: 0 0 #> .. range of y-values: 0 0 #> additional info elements: 0