plot_DetPlot function

Create De(t) plot

Create De(t) plot

Plots the equivalent dose (DeD_e) in dependency of the chosen signal integral (cf. Bailey et al., 2003). The function is simply passing several arguments to the function plot and the used analysis functions and runs it in a loop. Example: legend.pos for legend position, legend for legend text.

plot_DetPlot( object, signal.integral.min, signal.integral.max, background.integral.min, background.integral.max, method = "shift", signal_integral.seq = NULL, analyse_function = "analyse_SAR.CWOSL", analyse_function.control = list(), n.channels = NULL, show_ShineDownCurve = TRUE, respect_RC.Status = FALSE, multicore = TRUE, verbose = TRUE, plot = TRUE, ... )

Arguments

  • object: RLum.Analysis (required ): input object containing data for analysis Can be provided as a list of such objects.

  • signal.integral.min: integer (required ): lower bound of the signal integral.

  • signal.integral.max: integer (required ): upper bound of the signal integral. Must be strictly greater than signal.integral.min.

  • background.integral.min: integer (required ): lower bound of the background integral.

  • background.integral.max: integer (required ): upper bound of the background integral.

  • method: character (with default): method applied for constructing the De(t) plot.

    • shift (the default): the chosen signal integral is shifted the shine down curve,
    • expansion: the chosen signal integral is expanded each time by its length
  • signal_integral.seq: numeric (optional): argument to provide an own signal integral sequence for constructing the De(t) plot

  • analyse_function: character (with default): name of the analyse function to be called. Supported functions are: analyse_SAR.CWOSL , analyse_pIRIRSequence

  • analyse_function.control: list (optional): selected arguments to be passed to the supported analyse functions (analyse_SAR.CWOSL , analyse_pIRIRSequence ). The arguments must be provided as named list , e.g., list(dose.points = c(0,10,20,30,0,10) will set the regeneration dose points.

  • n.channels: integer (optional): number of channels used for the De(t) plot. If nothing is provided all De-values are calculated and plotted until the start of the background integral.

  • show_ShineDownCurve: logical (with default): enable/disable shine down curve in the plot output.

  • respect_RC.Status: logical (with default): remove De values with 'FAILED' RC.Status from the plot (cf. analyse_SAR.CWOSL

    and analyse_pIRIRSequence ).

  • multicore: logical (with default) : enable/disable multi core calculation if object is a list of RLum.Analysis objects. Can be an integer specifying the number of cores

  • verbose: logical (with default): enable/disable output to the terminal.

  • plot: logical (with default): enable/disable the plot output. Disabling the plot is useful in cases where the output need to be processed differently.

  • ...: further arguments and graphical parameters passed to plot.default , analyse_SAR.CWOSL and analyse_pIRIRSequence (see details for further information). Plot control parameters are: ylim, xlim, ylab, xlab, main, pch, mtext, cex, legend, legend.text, legend.pos

Returns

A plot and an RLum.Results object with the produced DeD_e values

@data:

ObjectTypeDescription
De.valuesdata.frametable with De values
signal_integral.seqnumericintegral sequence used for the calculation

@info:

ObjectTypeDescription
callcallthe original function call

Details

method

The original method presented by Bailey et al., 2003 shifted the signal integrals and slightly extended them accounting for changes in the counting statistics. Example: c(1:3, 3:5, 5:7). However, here also another method is provided allowing to expand the signal integral by consecutively expanding the integral by its chosen length. Example: c(1:3, 1:5, 1:7)

Note that in both cases the integral limits are overlap. The finally applied limits are part of the function output.

analyse_function.control

The argument analyse_function.control currently supports the following arguments: sequence.structure, dose.points, mtext.outer, fit.method, fit.force_through_origin, plot, plot_singlePanels

Note

The entire analysis is based on the used analysis functions, namely analyse_SAR.CWOSL and analyse_pIRIRSequence . However, the integrity checks of this function are not that thoughtful as in these functions itself. It means, that every sequence should be checked carefully before running long calculations using several hundreds of channels.

Function version

0.1.8

Examples

## Not run: ##load data ##ExampleData.BINfileData contains two BINfileData objects ##CWOSL.SAR.Data and TL.SAR.Data data(ExampleData.BINfileData, envir = environment()) ##transform the values from the first position in a RLum.Analysis object object <- Risoe.BINfileData2RLum.Analysis(CWOSL.SAR.Data, pos=1) plot_DetPlot( object, signal.integral.min = 1, signal.integral.max = 3, background.integral.min = 900, background.integral.max = 1000, n.channels = 5) ## End(Not run)

How to cite

Kreutzer, S., 2025. plot_DetPlot(): Create De(t) plot. Function version 0.1.8. 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., Colombo, M., Steinbuch, L., Boer, A.d., 2025. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 1.0.1. https://r-lum.github.io/Luminescence/

References

Bailey, R.M., Singarayer, J.S., Ward, S., Stokes, S., 2003. Identification of partial resetting using De as a function of illumination time. Radiation Measurements 37, 511-518. doi:10.1016/S1350-4487(03)00063-5

See Also

plot , analyse_SAR.CWOSL , analyse_pIRIRSequence

Author(s)

Sebastian Kreutzer, Institute of Geography, Ruprecht-Karl University of Heidelberg (Germany) , RLum Developer Team

  • Maintainer: Sebastian Kreutzer
  • License: GPL-3
  • Last published: 2025-03-07