OSLdecomposition (version 1.0.0)

sum_OSLcurves: Combine RLum OSL records to one global average curve

Description

This function adds up all CW-OSL records of the same type saved in RLum.Analysis objects and calculates the arithmetic mean signal from all records for each channel. This is useful to create global average curve with sufficient signal-to-noise ratio for OSL components identification with fit_OSLcurve or to create a signal background reference curve.

Usage

sum_OSLcurves(
  object,
  record_type = "OSL",
  aliquot_selection = NULL,
  offset_value = 0,
  verbose = TRUE,
  output.plot = FALSE,
  theme.set = ggplot2::theme_classic(),
  plot.first = FALSE,
  title = "default",
  filename = NULL
)

Value

A data.frame of the average CW-OSL curve is returned, containing two columns: $time and $signal.

Arguments

object

RLum.Analysis or list of RLum.Analysis (required): Data set of one or multiple aliquots containing CW-OSL records.

record_type

character (with default): Type of records which are selected from the input object, for example: "OSL","SGOSL" or "IRSL".

aliquot_selection

numeric vector (optional): Vector specifying the indices of elements (aliquots) of a list of RLum.Analysis objects which shall be included.

offset_value

numeric (with default): Signal offset (background) which will be subtracted from each record.

verbose

logical (with default): Enables console text output.

output.plot

logical (with default): returns a plot with all data points of all records and the average curve

theme.set

ggplot2 object (with default): sets the graphical theme of the output plot. See ggplot2::theme_bw for available themes

plot.first

logical (with default): Plot includes additional drawing of first record_type record of first object list element.

title

character (with default): Plot title. Set title = "default" for an automatically generated title. Set title = NULL for no title.

filename

character (optional): File name or path to save the plot as image. If just a file name is given, the image is saved in the working directory. The image type is chosen by the file ending. Both, vector images as well as pixel images are possible. Allowed are .pdf, .eps, .svg (vector graphics), .jpg, .png, .bmp (pixel graphics) and more, see ggplot2::ggsave.

Last updates

2020-10-30, DM: Overworked plotting; Expanded roxygen documentation

Author

Dirk Mittelstraß,

Please cite the package the following way:

Mittelstraß, D., Schmidt, C., Beyer, J., Heitmann, J. and Straessner, A.: R package OSLdecomposition: Automated identification and separation of quartz CW-OSL signal components, in preparation.

See Also

fit_OSLcurve, RLum.OSL_correction, RLum.OSL_global_fitting

Examples

# 'FB_10Gy' is a dose recovery test with the Fontainebleau quartz
# measured in a lexsyg research with green LED stimulation
data_path <- system.file("examples", "FB_10Gy_SAR.bin", package = "OSLdecomposition")
data_set <- Luminescence::read_BIN2R(data_path, fastForward = TRUE)

# Give average CW-OSL curve back
average_curve <- sum_OSLcurves(data_set)