Function imports Princeton Instruments (TM) SPE-files into R environment and provides RLum.Data.Image objects as output.
read_SPE2R(
file,
output.object = "RLum.Data.Image",
frame.range,
txtProgressBar = TRUE,
verbose = TRUE
)
character (required): SPE-file name (including path), e.g.
[WIN]
: read_SPE2R("C:/Desktop/test.spe")
[MAC/LINUX]
: readSPER("/User/test/Desktop/test.spe")
. Additionally internet connections
are supported.
character (with default):
set RLum
output object. Allowed types are "RLum.Data.Spectrum"
,
"RLum.Data.Image"
or "matrix"
vector (optional):
limit frame range, e.g. select first 100 frames by frame.range = c(1,100)
logical (with default): enables or disables txtProgressBar.
logical (with default): enables or disables verbose mode
Depending on the chosen option the functions returns three different type of objects:
output.object
RLum.Data.Spectrum
An object of type RLum.Data.Spectrum is returned. Row sums are used to integrate all counts over one channel.
RLum.Data.Image
An object of type RLum.Data.Image is returned. Due to
performance reasons the import is aborted for files containing more than 100
frames. This limitation can be overwritten manually by using the argument
frame.range
.
matrix
Returns a matrix of the form: Rows = Channels, columns = Frames. For the
transformation the function get_RLum is used,
meaning that the same results can be obtained by using the function
get_RLum on an RLum.Data.Spectrum
or RLum.Data.Image
object.
Function provides an R only import routine for the Princeton Instruments SPE format. Import functionality is based on the file format description provided by Princeton Instruments and a MatLab script written by Carl Hall (s. references).
The function does not test whether the input data are spectra or pictures for spatial resolved analysis!
The function has been successfully tested for SPE format versions 2.x.
Currently not all information provided by the SPE format are supported.
0.1.4
Kreutzer, S., 2023. read_SPE2R(): Import Princeton Instruments (TM) SPE-file into R. Function version 0.1.4. 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., 2023. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.23. https://CRAN.R-project.org/package=Luminescence
Princeton Instruments, 2014. Princeton Instruments SPE 3.0 File Format Specification, Version 1.A (for document URL please use an internet search machine)
Hall, C., 2012: readSPE.m.
https://www.mathworks.com/matlabcentral/fileexchange/35940-readspe
## to run examples uncomment lines and run the code
##(1) Import data as RLum.Data.Spectrum object
#file <- file.choose()
#temp <- read_SPE2R(file)
#temp
##(2) Import data as RLum.Data.Image object
#file <- file.choose()
#temp <- read_SPE2R(file, output.object = "RLum.Data.Image")
#temp
##(3) Import data as matrix object
#file <- file.choose()
#temp <- read_SPE2R(file, output.object = "matrix")
#temp
##(4) Export raw data to csv, if temp is a RLum.Data.Spectrum object
# write.table(x = get_RLum(temp),
# file = "[your path and filename]",
# sep = ";", row.names = FALSE)