Object class to represent analysis data for protocol analysis, i.e. all curves, spectra etc. from one measurements. Objects from this class are produced, by e.g. read_XSYG2R, read_Daybreak2R
# S4 method for RLum.Analysis show(object) # S4 method for RLum.Analysis set_RLum( class, originator, .uid, .pid, protocol = NA_character_, records = list(), info = list() ) # S4 method for RLum.Analysis get_RLum( object, record.id = NULL, recordType = NULL, curveType = NULL, RLum.type = NULL, protocol = "UNKNOWN", get.index = NULL, drop = TRUE, recursive = TRUE, info.object = NULL, subset = NULL, env = parent.frame(2) ) # S4 method for RLum.Analysis structure_RLum(object, fullExtent = FALSE) # S4 method for RLum.Analysis length_RLum(object) # S4 method for RLum.Analysis names_RLum(object) # S4 method for RLum.Analysis smooth_RLum(object, ...)
object |
|
---|---|
class |
|
originator |
|
.uid |
|
.pid |
|
protocol |
|
records | |
info |
Returns an RLum.Analysis object. |
record.id |
|
recordType |
|
curveType |
|
RLum.type |
|
get.index |
|
drop |
|
recursive |
|
info.object |
|
subset |
|
env |
|
fullExtent | structure_RLum; logical (with default):
extents the returned |
... | further arguments passed to underlying methods |
get_RLum
:
Returns:
Single RLum.Data object, if only one object is contained and recursive = FALSE
or
RLum.Analysis objects for drop = FALSE
structure_RLum
:
Returns data.frame showing the structure.
length_RLum
Returns the number records in this object.
names_RLum
Returns the names of the record types (recordType
) in this object.
smooth_RLum
Same object as input, after smoothing
show
: Show structure of RLum.Analysis
object
set_RLum
: Construction method for RLum.Analysis objects.
get_RLum
: Accessor method for RLum.Analysis object.
The slots record.id, recordType, curveType and RLum.type are optional to allow for records limited by their id (list index number), their record type (e.g. recordType = "OSL") or object type.
Example: curve type (e.g. curveType = "predefined" or curveType ="measured")
The selection of a specific RLum.type object superimposes the default selection. Currently supported objects are: RLum.Data.Curve and RLum.Data.Spectrum
structure_RLum
: Method to show the structure of an RLum.Analysis object.
length_RLum
: Returns the length of the object, i.e., number of stored records.
names_RLum
: Returns the names of the RLum.Data objects objects (same as shown with the show method)
smooth_RLum
: Smoothing of RLum.Data
objects contained in this RLum.Analysis
object
zoo::rollmean or zoo::rollmedian. In particular the internal
function .smoothing
is used.
protocol
Object of class character describing the applied measurement protocol
records
The method structure_RLum is currently just available for objects containing RLum.Data.Curve.
Objects can be created by calls of the form set_RLum("RLum.Analysis", ...)
.
0.4.16
Sebastian Kreutzer, Geography & Earth Sciences, Aberystwyth University (United Kingdom) , RLum Developer Team
Kreutzer, S., 2021. RLum.Analysis-class(): Class 'RLum.Analysis'. 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.Analysis")#> Class "RLum.Analysis" [package "Luminescence"] #> #> Slots: #> #> Name: protocol records originator info .uid .pid #> Class: character list character list character character #> #> Extends: "RLum"#> #> [RLum.Analysis-class] #> originator: eval() #> protocol: NA #> additional info elements: 0 #> number of records: 0 #> >> This is an empty object, which cannot be used for further analysis! <<###use example data ##load data data(ExampleData.RLum.Analysis, envir = environment()) ##show curves in object get_RLum(IRSAR.RF.Data)#> [[1]] #> #> [RLum.Data.Curve-class] #> recordType: RF #> curveType: NA #> measured values: 5 #> .. range of x-values: 0.1747448 6.311132 #> .. range of y-values: 1423.15 1437.8 #> additional info elements: 0 #> [[2]] #> #> [RLum.Data.Curve-class] #> recordType: RF #> curveType: NA #> measured values: 524 #> .. range of x-values: 0.3768403 715.4821 #> .. range of y-values: 1379.947 2103.4 #> additional info elements: 0##show only the first object, but by keeping the object get_RLum(IRSAR.RF.Data, record.id = 1, drop = FALSE)#> #> [RLum.Analysis-class] #> originator: NA() #> protocol: IRSAR #> additional info elements: 0 #> number of records: 1 #> .. : RLum.Data.Curve : 1 #> .. .. : #1 RF