RLum.Data.Image-class {Luminescence} | R Documentation |
Class "RLum.Data.Image"
Description
Class for representing luminescence image data (TL/OSL/RF). Such data are for example produced by the function read_SPE2R
Usage
## S4 method for signature 'RLum.Data.Image'
show(object)
## S4 method for signature 'RLum.Data.Image'
set_RLum(
class,
originator,
.uid,
.pid,
recordType = "Image",
curveType = NA_character_,
data = array(),
info = list()
)
## S4 method for signature 'RLum.Data.Image'
get_RLum(object, info.object)
## S4 method for signature 'RLum.Data.Image'
names_RLum(object)
Arguments
object |
|
class |
|
originator |
|
.uid |
|
.pid |
|
recordType |
|
curveType |
|
data |
|
info |
|
info.object |
Value
set_RLum
Returns an object from class RLum.Data.Image
get_RLum
Returns the data object (array)
only the info object if
info.object
was set.
names_RLum
Returns the names of the info elements
Methods (by generic)
-
show(RLum.Data.Image)
: Show structure ofRLum.Data.Image
object -
set_RLum(RLum.Data.Image)
: Construction method for RLum.Data.Image object. The slot info is optional and predefined as empty list by default. -
get_RLum(RLum.Data.Image)
: Accessor method forRLum.Data.Image
object. The argumentinfo.object
is optional to directly access the info elements. If no info element name is provided, the raw image data (array
) will be returned. -
names_RLum(RLum.Data.Image)
: 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. "OSL image", "TL image")
curveType
Object of class character containing curve type, allowed values are measured or predefined
data
Object of class array containing image data.
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.Image", ...)
.
Class version
0.5.1
How to cite
Kreutzer, S., 2024. RLum.Data.Image-class(): Class 'RLum.Data.Image'. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., Mercier, N., Philippe, A., Riedesel, S., Autzen, M., Mittelstrass, D., Gray, H.J., Galharret, J., 2024. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.24. https://CRAN.R-project.org/package=Luminescence
Note
The class should only contain data for a set of images. For additional
elements the slot info
can be used.
Author(s)
Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) , RLum Developer Team
See Also
RLum, RLum.Data, plot_RLum, read_SPE2R, read_TIFF2R
Examples
showClass("RLum.Data.Image")
##create empty RLum.Data.Image object
set_RLum(class = "RLum.Data.Image")