pickBINdata: BIN data set selection

In numOSL: Numeric Routines for Optically Stimulated Luminescence Dating

BIN data set selection

Description

Extracting data sets from a loaded BIN (BINX) file.

Usage

pickBINdata(obj_loadBIN, Position = NULL, Grain = NULL, 
            Run = NULL, Set = NULL, DType = NULL, 
            IRRTime = NULL, NPoints = NULL, LType = NULL, 
            Low = NULL, High = NULL, Rate = NULL, 
            Temperature = NULL, Delay = NULL, On = NULL, 
            Off = NULL, LightSource = NULL, AnTemp = NULL, 
            TimeSinceIrr = NULL, view = TRUE, 
            manual.select = FALSE, force.matrix = FALSE)

Arguments

obj_loadBIN	list(required): an object of S3 class "loadBIN" produced by function loadBINdata
Position	vector(optional): carousel position, Example: Position=1:48
Grain	vector(optional): grain number
Run	vector(optional): run number
Set	vector(optional): set number
DType	character(optional): a character vector indicating data type, Example: DType=c("Natural", "N+dose")
IRRTime	vector(optional): irradiation time
NPoints	vector(optional): number of data points
LType	character(optional): a character vector indicating luminescence types, Example: LType="OSL"
Low	vector(optional): lower limit on temperature, time, or wavelength
High	vector(optional): upper limit on temperature, time, or wavelength
Rate	vector(optional): increasing rate of temperature, time, or wavelength
Temperature	vector(optional): a vector indicating the sample temperatures
Delay	vector(optional): TOL "delay" channels
On	vector(optional): TOL "on" channels
Off	vector(optional): TOL "off" channels
LightSource	character(optional): a character vector indicating light source, Example: LightSource="BlueDiodes"
AnTemp	vector(optional): annealing temperature
TimeSinceIrr	vector(optional): time since irradiation
view	logical(with default): logical value indicating if the loaded data should be visualized in a Summary Table
manual.select	logical(with default): logical value indicating if the loaded data should be selected manually using a Summary Table
force.matrix	logical(with default): logical value indicating if the picked data sets of an aliquot (grain) should be transformed into a matrix

Details

Function pickBINdata is used for pick up data sets from an object of S3 class "loadBIN" generated using function loadBINdata. Set force.matrix=TRUE will transform data sets of an aliquot (grain) into a matrix, the transformation fails if data sets have different x (temperature, time, or wavelength) coordinates. Transformed data sets stored in a matrix can be visualize via matplot (see examples).

Value

Return an invisible list of S3 class object "pickBIN" containing two elements:

BINdata	selected BIN data
agID	Aliquot or grain ID (i.e., c("NO","Position","Grain")) of selected data sets, it returns NULL if force.matrix=TRUE

References

Duller GAT, 2016. Analyst (v4.31.9), User Mannual.

See Also

loadBINdata; analyseBINdata; BIN; decomp; fastED

Examples

   ### Example 1 (visualize decay curves for Position=2):
   data(BIN)
   obj_pickBIN <- pickBINdata(BIN, Position=2, view=FALSE,
                              LType="OSL", force.matrix=TRUE)
   matplot(obj_pickBIN$BINdata[[1]][,1], 
           obj_pickBIN$BINdata[[1]][,-1], 
           main="Decay curves",
           xlab="Stimulation time (s)",
           ylab="Photon counts",
           type="l", log="xy")

  ### Example 2 (visualize test-dose decay curves for Position=2):
  obj_pickBIN <- pickBINdata(BIN, Position=2, Run=c(5,11,17,23,29,34,40), 
                             view=FALSE, LType="OSL", force.matrix=TRUE)
  matplot(obj_pickBIN$BINdata[[1]][,1], 
          obj_pickBIN$BINdata[[1]][,-1], 
          main="Test-dose decay curves",
          xlab="Stimulation time (s)",
          ylab="Photon counts",
          type="l", log="xy")

  ### Example 3 (visualize regenerative-dose decay curves for Position=2):
  obj_pickBIN <- pickBINdata(BIN, Position=2, Run=c(8,14,20,26,31,37), 
                             view=FALSE, LType="OSL", force.matrix=TRUE)
  matplot(obj_pickBIN$BINdata[[1]][,1], 
          obj_pickBIN$BINdata[[1]][,-1], 
          main="Regenerative-dose decay curves",
          xlab="Stimulation time (s)",
          ylab="Photon counts",
          type="l", log="xy")

numOSL documentation built on Sept. 18, 2023, 9:07 a.m.