Dose Rate Estimation from in-Situ Gamma-Ray Spectrometry Measurements

Process in-situ Gamma-Ray Spectrometry for Luminescence Dating. This package allows to import, inspect and correct the energy shifts of gamma-ray spectra. It provides methods for estimating the gamma dose rate by the use of a calibration curve as described in Mercier and Falguères (2007). The package only supports Canberra CNF and TKA and Kromek SPE files.


gamma

R-CMD-check Codecov testcoverage

r-universe CRAN Version CRAN checks CRAN Downloads

Project Status: Active – The project has reached a stable, usablestate and is being activelydeveloped.

DOI

SWH

Overview

gamma is intended to process in-situ gamma-ray spectrometry measurements for luminescence dating. This package allows to import, inspect and (automatically) correct the energy scale of the spectrum. It provides methods for estimating the gamma dose rate by the use of a calibration curve. This package only supports Canberra CNF and TKA and Kromek SPE files.

The gammaShiny package provides an enhanced graphical user interface for the main applications of gamma.

To cite gamma in publications use:

  Lebrun B, Frerebeau N, Paradol G, Guérin G, Mercier N, Tribolo C,
  Lahaye C, Rizza M (2020). "gamma: An R Package for Dose Rate
  Estimation from In-Situ Gamma-Ray Spectrometry Measurements."
  _Ancient TL_, *38*(2), 1-5. doi:10.26034/la.atl.2020.544
  <https://doi.org/10.26034/la.atl.2020.544>.

  Frerebeau N, Lebrun B, Paradol G, Kreutzer S (2026). _gamma: Dose
  Rate Estimation from in-Situ Gamma-Ray Spectrometry_. Université
  Bordeaux Montaigne, Pessac, France. doi:10.5281/zenodo.2652393
  <https://doi.org/10.5281/zenodo.2652393>. R package version 1.2.0.

Installation

You can install the released version of gamma from CRAN with:

install.packages("gamma")

And the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("crp2a/gamma")

Usage

## A minimal example
library(gamma)

## Find the full path to the spectrum file
spc_file <- system.file("extdata/LaBr.CNF", package = "gamma")
## Import the spectrum
spectrum <- read(spc_file)

## Set the expected channel/energy peaks for the energy scale calibration
## Spectrum pre-processing and peak detection
peaks <- spectrum |>
  signal_slice() |>
  signal_stabilize(f = sqrt) |>
  signal_smooth(method = "savitzky", m = 21) |>
  signal_correct(method = "SNIP", n = 100) |>
  peaks_find()

## Set the energy values (in keV)
set_energy(peaks) <- c(238, NA, NA, NA, 1461, NA, NA, 2615)

## Calibrate the energy scale
calib <- energy_calibrate(spectrum, peaks)

## Inspect peaks
plot(calib, peaks)
## Load the calibration curve for the dose rate estimation
## As this curve is instrument specific, you will have to build your own
data("BDX_LaBr_1", package = "gamma")
plot(BDX_LaBr_1)
## Estimate the gamma dose rate
(doses <- dose_predict(BDX_LaBr_1, calib))
name signal_Ni signal_err_Ni dose_Ni dose_err_Ni signal_NiEi signal_err_NiEi dose_NiEi dose_err_NiEi dose_final dose_err_final
LaBr 141.014 0.2253903 4171.876 111.5254 126234.7 6.893242 3944.501 98.11905 4058.189 148.1876

Contributing

Please note that the gamma project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Acknowledgements

This work received a state financial support managed by the Agence Nationale de la Recherche (France) through the program Investissements d’avenir (ref. 10-LABX-0052 and 11-IDEX-0001).

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("gamma")

1.2.0 by Archéosciences Bordeaux, 9 days ago


https://crp2a.github.io/gamma/, https://github.com/crp2a/gamma


Report a bug at https://github.com/crp2a/gamma/issues


Browse source code at https://github.com/cran/gamma


Authors: Nicolas Frerebeau [aut] (ORCID: , Brice Lebrun [aut] , Guilhem Paradol [aut] , Magali Rizza [ctb] , Christelle Lahaye [ctb] (ORCID: , Sebastian Kreutzer [aut] (ORCID: , Archéosciences Bordeaux [cre] , Université Bordeaux Montaigne [fnd] (ROR: <https://ror.org/03pbgwk21>) , CNRS [fnd] (ROR: <https://ror.org/02feahw73>) , LabEx Sciences archéologiques de Bordeaux [fnd] , Idex Aix-Marseille [fnd]


Documentation:   PDF Manual  


GPL-3 license


Imports ggplot2, IsoplotR, methods, rlang, rxylib, stats, tools, utils

Suggests covr, knitr, rmarkdown, testthat, vdiffr


See at CRAN