diff --git a/NEWS.md b/NEWS.md index 49a6370..08a2550 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,6 +2,10 @@ ## Additions * Add user friendly coercion methods: `as_peaks()` and `as_spectra()`. +## Datasets +* Add reference datasets for calibration sites around Heidelberg and the CZT detector calibration +files as detailed in Kreutzer et al. (2025, Geochronology) (PR #54 by @RLumSK) + # gamma 1.1.0 ## Bugfixes * Fix an error in the uncertainty calculation of `dose_predict()`. The returned error was too large and did not make much sense due to an internal calculation error. Along with the fix, the manual was updated to detail the uncertainty calculation (PR #42 by @RLumSK). diff --git a/R/data.R b/R/data.R index 30f32ef..943f229 100644 --- a/R/data.R +++ b/R/data.R @@ -2,7 +2,7 @@ #' Nuclear Decay Data #' #' An internal dataset containing the decay data for the following isotopes: -#' 232-Th, 235-U, 238-U and 40-K. +#' Th-232, U-235, U-238 and K-40. #' @format #' A [`data.frame`] with the following columns (absolute errors): #' \describe{ @@ -62,10 +62,12 @@ NULL #' @source #' Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors: #' Update. *Ancient TL*, 29(1), p. 5-8. +#' \doi{10.26034/la.atl.2011.443} #' #' Miallier, D., Guérin, G., Mercier, N., Pilleyre, T. & Sanzelle, S. #' (2009). The Clermont Radiometric Reference Rocks: A Convenient Tool #' for Dosimetric Purposes. *Ancient TL*, 27(2), p. 37-44. +#' \doi{10.26034/la.atl.2009.428} #' @family datasets #' @keywords datasets "clermont" @@ -85,13 +87,16 @@ NULL #' @source #' Adamiec, G. & Aitken, M.J. (1998). #' Dose-rate conversion factors: update. *Ancient TL*, 16, p. 37–50. +#' \doi{10.26034/la.atl.1998.292} #' #' Cresswell, A.J., Carter, J. & Sanderson, D.C.W. (2018). Dose rate #' conversion parameters: Assessment of nuclear data. #' *Radiation Measurements*, 120, p. 195–201. +#' \doi{10.1016/j.radmeas.2018.02.007} #' #' Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors: #' Update. *Ancient TL*, 29(1), p. 5-8. +#' \doi{10.26034/la.atl.2011.443} #' #' Liritzis, I., Stamoulis, K., Papachristodoulou, C. & Ioannides, K. (2013). #' A re-evaluation of radiation dose-rate conversion factors. @@ -100,10 +105,49 @@ NULL #' Miallier, D., Guérin, G., Mercier, N., Pilleyre, T. & Sanzelle, S. #' (2009). The Clermont Radiometric Reference Rocks: A Convenient Tool #' for Dosimetric Purposes. *Ancient TL*, 27(2), p. 37-44. +#' \doi{10.26034/la.atl.2009.428} #' @family datasets #' @keywords datasets "clermont_2024" +# ============================================================================== +#' Heidelberg Reference Data 2024 +#' +#' Reference data for the calibration sites near Heidelberg as detailed +#' in Kreutzer at al. (2025) +#' +#' @usage data("heidelberg_2024") +#' @format A [`data.frame`] with tabulated data and conversion factor reference. +#' @source +#' Adamiec, G. & Aitken, M.J. (1998). +#' Dose-rate conversion factors: update. *Ancient TL*, 16, p. 37–50. +#' \doi{10.26034/la.atl.1998.292} +#' +#' Cresswell, A.J., Carter, J. & Sanderson, D.C.W. (2018). Dose rate +#' conversion parameters: Assessment of nuclear data. +#' *Radiation Measurements*, 120, p. 195–201. +#' \doi{10.1016/j.radmeas.2018.02.007} +#' +#' Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors: +#' Update. *Ancient TL*, 29(1), p. 5-8. +#' \doi{10.26034/la.atl.2011.443} +#' +#' Liritzis, I., Stamoulis, K., Papachristodoulou, C. & Ioannides, K. (2013). +#' A re-evaluation of radiation dose-rate conversion factors. +#' *Mediterranean Archaeology and Archaeometry*, 12, p. 1–15. +#' +#' @family datasets +#' @references +#' Kreutzer, S., Martin, L., Miallier, D. & Mercier, N. (2025). +#' Environmental gamma dose rate measurements using cadmium zinc telluride (CZT) detectors. +#' *Geochronology*, 7, p. 229–246. \doi{10.5194/gchron-7-229-2025} +#' +#' Kreutzer, S., Martin, L., Miallier, D., Mercier, N. & Faske, M. (2024). +#' Dataset: Environmental Gamma Dose Rate Measurements using CZT Detectors (1.0.0). +#' *Zenodo*. \doi{10.5281/zenodo.13731839} +#' @keywords datasets +"heidelberg_2024" + #' CEREGE Calibration Curve (NaI) #' #' @usage data(AIX_NaI_1) @@ -141,3 +185,45 @@ NULL #' @family datasets #' @keywords datasets "BDX_LaBr_1" + +#' heiLUM Calibration Curve (CZT) +#' +#' @usage data(HD_CZT_1) +#' @format +#' Objects of class [CalibrationCurve-class]. +#' \tabular{ll}{ +#' **Laboratory** \tab heiLUM, Heidelberg University, DE \cr +#' **Instrument** \tab Kromek GR1 & Kromek RayMon10 (SN: 5261)\cr +#' **Detector** \tab GR1+ (SN: 1625) & GR1 (SN: 1663) \cr +#' **Authors** \tab Sebastian Kreutzer, Didier Maillier, Norbert Mercier, heiLUM Team +#' } +#' +#' The calibration dataset consists of the following objects: +#' +#' * CAL_GR1_AdamiecAitken1998 +#' * CAL_GR1_Cresswelletal2018 +#' * CAL_GR1_Gurinetal2011 +#' * CAL_GR1_Liritzisetal2013 +#' * CAL_RAYMON_GR1_AdamiecAitken1998 +#' * CAL_RAYMON_GR1_Cresswelletal2018 +#' * CAL_RAYMON_GR1_Gurinetal2011 +#' * CAL_RAYMON_GR1_Liritzisetal2013 +#' +#' @examples +#' ## Load the curve +#' data(HD_CZT_1, package = "gamma") +#' names(HD_CZT_1) +#' plot(HD_CZT_1$CAL_GR1_AdamiecAitken1998) +#' +#' @references +#' Kreutzer, S., Martin, L., Miallier, D. & Mercier, N. (2025). +#' Environmental gamma dose rate measurements using cadmium zinc telluride (CZT) detectors. +#' *Geochronology*, 7, p. 229–246. \doi{10.5194/gchron-7-229-2025} +#' +#' Kreutzer, S., Martin, L., Miallier, D., Mercier, N. & Faske, M. (2024). +#' Dataset: Environmental Gamma Dose Rate Measurements using CZT Detectors (1.0.0). +#' *Zenodo*. \doi{10.5281/zenodo.13731839} +#' +#' @family datasets +#' @keywords datasets +"HD_CZT_1" diff --git a/data-raw/DATASET.R b/data-raw/DATASET.R index bbfbb4a..e9b0e57 100644 --- a/data-raw/DATASET.R +++ b/data-raw/DATASET.R @@ -17,6 +17,11 @@ clermont <- utils::read.table("./data-raw/clermont.csv", rownames(clermont) <- clermont[["name"]] usethis::use_data(clermont, internal = FALSE, overwrite = FALSE) +# Milieux Heidelberg =========================================================== +heidelberg_2024 <- utils::read.table("./data-raw/heidelberg_2024.csv", + header = TRUE, sep = ",", dec = ".") +usethis::use_data(heidelberg_2024, internal = FALSE, overwrite = FALSE) + # Decay data =================================================================== .decay <- utils::read.table("./data-raw/decay.csv", header = TRUE, sep = ";", dec = ",") |> diff --git a/data-raw/heidelberg_2024.csv b/data-raw/heidelberg_2024.csv new file mode 100644 index 0000000..c204e67 --- /dev/null +++ b/data-raw/heidelberg_2024.csv @@ -0,0 +1,9 @@ +name,laboratory,nature,U,U_error,Th,Th_error,K2O,K2O_error,K,K_error,gamma_dose,gamma_error,cosmic_dose,cosmic_error,ref_conversion_factors,conv_U,conv_U_error,conv_Th,conv_Th_error,conv_K,conv_K_error +FLOSSI,"Max-Planck-Institute for Nuclear Physics, Heidelberg, DE",granite,19.02,0.74,13.25,0.50,,,4.11,0.095,3778.690,92.096,203,20,Adamiec & Aitken (1998),0.113000000,0.000202147,0.047600000,0.000197921,0.243000000,0.004669335 +WH2024,"Weisse Hohl (natural site), DE",loess,3.09,0.02,9.44,0.53,,,1.20,0.01,1090.114,26.129,141,14,Adamiec & Aitken (1998),0.113000000,0.000202147,0.047600000,0.000197921,0.243000000,0.004669335 +FLOSSI,"Max-Planck-Institute for Nuclear Physics, Heidelberg, DE",granite,19.02,0.74,13.25,0.50,,,4.11,0.095,3781.108,91.445,203,20,Guérin et al. (2011),0.111600000,0.000199642,0.047900000,0.000199168,0.249100000,0.004786549 +WH2024,"Weisse Hohl (natural site), DE",loess,3.09,0.02,9.44,0.53,,,1.20,0.01,1095.940,26.435,141,14,Guérin et al. (2011),0.111600000,0.000199642,0.047900000,0.000199168,0.249100000,0.004786549 +FLOSSI,"Max-Planck-Institute for Nuclear Physics, Heidelberg, DE",granite,19.02,0.74,13.25,0.50,,,4.11,0.095,3790.439,91.634,203,20,Liritzis et al. (2013),0.111800000,0.000200000,0.048100000,0.000200000,0.249800000,0.004800000 +WH2024,"Weisse Hohl (natural site), DE",loess,3.09,0.02,9.44,0.53,,,1.20,0.01,1099.286,26.543,141,14,Liritzis et al. (2013),0.111800000,0.000200000,0.048100000,0.000200000,0.249800000,0.004800000 +FLOSSI,"Max-Planck-Institute for Nuclear Physics, Heidelberg, DE",granite,19.02,0.74,13.25,0.50,,,4.11,0.095,3797.445,92.475,203,20,Cresswell et al. (2018),0.112000000,0.001000000,0.048900000,0.000300000,0.248000000,0.003000000 +WH2024,"Weisse Hohl (natural site), DE",loess,3.09,0.02,9.44,0.53,,,1.20,0.01,1105.296,26.826,141,14,Cresswell et al. (2018),0.112000000,0.001000000,0.048900000,0.000300000,0.248000000,0.003000000 \ No newline at end of file diff --git a/data/HD_CZT_1.rda b/data/HD_CZT_1.rda new file mode 100644 index 0000000..f3f7131 Binary files /dev/null and b/data/HD_CZT_1.rda differ diff --git a/data/datalist b/data/datalist index 0ebee88..5ff0fef 100644 --- a/data/datalist +++ b/data/datalist @@ -2,3 +2,5 @@ AIX_NaI_1: AIX_NaI_1 BDX_LaBr_1: BDX_LaBr_1 clermont_2024: clermont_2024 clermont: clermont +HD_CZT_1: HD_CZT_1 +heidelberg_2024: heidelberg_2024 diff --git a/data/heidelberg_2024.rda b/data/heidelberg_2024.rda new file mode 100644 index 0000000..26cab64 Binary files /dev/null and b/data/heidelberg_2024.rda differ diff --git a/man/AIX_NaI_1.Rd b/man/AIX_NaI_1.Rd index ebb0f6a..b345867 100644 --- a/man/AIX_NaI_1.Rd +++ b/man/AIX_NaI_1.Rd @@ -27,8 +27,10 @@ plot(AIX_NaI_1) \seealso{ Other datasets: \code{\link{BDX_LaBr_1}}, +\code{\link{HD_CZT_1}}, \code{\link{clermont}}, -\code{\link{clermont_2024}} +\code{\link{clermont_2024}}, +\code{\link{heidelberg_2024}} } \concept{datasets} \keyword{datasets} diff --git a/man/BDX_LaBr_1.Rd b/man/BDX_LaBr_1.Rd index 47f132d..080873e 100644 --- a/man/BDX_LaBr_1.Rd +++ b/man/BDX_LaBr_1.Rd @@ -27,8 +27,10 @@ plot(BDX_LaBr_1) \seealso{ Other datasets: \code{\link{AIX_NaI_1}}, +\code{\link{HD_CZT_1}}, \code{\link{clermont}}, -\code{\link{clermont_2024}} +\code{\link{clermont_2024}}, +\code{\link{heidelberg_2024}} } \concept{datasets} \keyword{datasets} diff --git a/man/HD_CZT_1.Rd b/man/HD_CZT_1.Rd new file mode 100644 index 0000000..afe2983 --- /dev/null +++ b/man/HD_CZT_1.Rd @@ -0,0 +1,59 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{HD_CZT_1} +\alias{HD_CZT_1} +\title{heiLUM Calibration Curve (CZT)} +\format{ +Objects of class \linkS4class{CalibrationCurve}. +\tabular{ll}{ +\strong{Laboratory} \tab heiLUM, Heidelberg University, DE \cr +\strong{Instrument} \tab Kromek GR1 & Kromek RayMon10 (SN: 5261)\cr +\strong{Detector} \tab GR1+ (SN: 1625) & GR1 (SN: 1663) \cr +\strong{Authors} \tab Sebastian Kreutzer, Didier Maillier, Norbert Mercier, heiLUM Team +} + +The calibration dataset consists of the following objects: +\itemize{ +\item CAL_GR1_AdamiecAitken1998 +\item CAL_GR1_Cresswelletal2018 +\item CAL_GR1_Gurinetal2011 +\item CAL_GR1_Liritzisetal2013 +\item CAL_RAYMON_GR1_AdamiecAitken1998 +\item CAL_RAYMON_GR1_Cresswelletal2018 +\item CAL_RAYMON_GR1_Gurinetal2011 +\item CAL_RAYMON_GR1_Liritzisetal2013 +} +} +\usage{ +data(HD_CZT_1) +} +\description{ +heiLUM Calibration Curve (CZT) +} +\examples{ +## Load the curve +data(HD_CZT_1, package = "gamma") +names(HD_CZT_1) +plot(HD_CZT_1$CAL_GR1_AdamiecAitken1998) + +} +\references{ +Kreutzer, S., Martin, L., Miallier, D. & Mercier, N. (2025). +Environmental gamma dose rate measurements using cadmium zinc telluride (CZT) detectors. +\emph{Geochronology}, 7, p. 229–246. \doi{10.5194/gchron-7-229-2025} + +Kreutzer, S., Martin, L., Miallier, D., Mercier, N. & Faske, M. (2024). +Dataset: Environmental Gamma Dose Rate Measurements using CZT Detectors (1.0.0). +\emph{Zenodo}. \doi{10.5281/zenodo.13731839} +} +\seealso{ +Other datasets: +\code{\link{AIX_NaI_1}}, +\code{\link{BDX_LaBr_1}}, +\code{\link{clermont}}, +\code{\link{clermont_2024}}, +\code{\link{heidelberg_2024}} +} +\concept{datasets} +\keyword{datasets} diff --git a/man/clermont.Rd b/man/clermont.Rd index 386dbfa..bb06076 100644 --- a/man/clermont.Rd +++ b/man/clermont.Rd @@ -10,10 +10,12 @@ A \code{\link{data.frame}} with tabulated data and conversion factor reference. \source{ Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors: Update. \emph{Ancient TL}, 29(1), p. 5-8. +\doi{10.26034/la.atl.2011.443} Miallier, D., Guérin, G., Mercier, N., Pilleyre, T. & Sanzelle, S. (2009). The Clermont Radiometric Reference Rocks: A Convenient Tool for Dosimetric Purposes. \emph{Ancient TL}, 27(2), p. 37-44. +\doi{10.26034/la.atl.2009.428} } \usage{ data("clermont") @@ -25,7 +27,9 @@ Clermont Reference Data Other datasets: \code{\link{AIX_NaI_1}}, \code{\link{BDX_LaBr_1}}, -\code{\link{clermont_2024}} +\code{\link{HD_CZT_1}}, +\code{\link{clermont_2024}}, +\code{\link{heidelberg_2024}} } \concept{datasets} \keyword{datasets} diff --git a/man/clermont_2024.Rd b/man/clermont_2024.Rd index 0573031..1351a45 100644 --- a/man/clermont_2024.Rd +++ b/man/clermont_2024.Rd @@ -10,13 +10,16 @@ A \code{\link{data.frame}} with tabulated data and conversion factor reference. \source{ Adamiec, G. & Aitken, M.J. (1998). Dose-rate conversion factors: update. \emph{Ancient TL}, 16, p. 37–50. +\doi{10.26034/la.atl.1998.292} Cresswell, A.J., Carter, J. & Sanderson, D.C.W. (2018). Dose rate conversion parameters: Assessment of nuclear data. \emph{Radiation Measurements}, 120, p. 195–201. +\doi{10.1016/j.radmeas.2018.02.007} Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors: Update. \emph{Ancient TL}, 29(1), p. 5-8. +\doi{10.26034/la.atl.2011.443} Liritzis, I., Stamoulis, K., Papachristodoulou, C. & Ioannides, K. (2013). A re-evaluation of radiation dose-rate conversion factors. @@ -25,6 +28,7 @@ A re-evaluation of radiation dose-rate conversion factors. Miallier, D., Guérin, G., Mercier, N., Pilleyre, T. & Sanzelle, S. (2009). The Clermont Radiometric Reference Rocks: A Convenient Tool for Dosimetric Purposes. \emph{Ancient TL}, 27(2), p. 37-44. +\doi{10.26034/la.atl.2009.428} } \usage{ data("clermont_2024") @@ -41,7 +45,9 @@ errors. Other datasets: \code{\link{AIX_NaI_1}}, \code{\link{BDX_LaBr_1}}, -\code{\link{clermont}} +\code{\link{HD_CZT_1}}, +\code{\link{clermont}}, +\code{\link{heidelberg_2024}} } \concept{datasets} \keyword{datasets} diff --git a/man/decay.Rd b/man/decay.Rd index db4958d..b0d4180 100644 --- a/man/decay.Rd +++ b/man/decay.Rd @@ -26,7 +26,7 @@ Nuclides And Isotopes : Chart of the Nuclides. } \description{ An internal dataset containing the decay data for the following isotopes: -232-Th, 235-U, 238-U and 40-K. +Th-232, U-235, U-238 and K-40. } \keyword{datasets} \keyword{internal} diff --git a/man/heidelberg_2024.Rd b/man/heidelberg_2024.Rd new file mode 100644 index 0000000..45ba8af --- /dev/null +++ b/man/heidelberg_2024.Rd @@ -0,0 +1,53 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{heidelberg_2024} +\alias{heidelberg_2024} +\title{Heidelberg Reference Data 2024} +\format{ +A \code{\link{data.frame}} with tabulated data and conversion factor reference. +} +\source{ +Adamiec, G. & Aitken, M.J. (1998). +Dose-rate conversion factors: update. \emph{Ancient TL}, 16, p. 37–50. +\doi{10.26034/la.atl.1998.292} + +Cresswell, A.J., Carter, J. & Sanderson, D.C.W. (2018). Dose rate +conversion parameters: Assessment of nuclear data. +\emph{Radiation Measurements}, 120, p. 195–201. +\doi{10.1016/j.radmeas.2018.02.007} + +Guérin, G., Mercier, N. & Adamiec, G. (2011). Dose-Rate Conversion Factors: +Update. \emph{Ancient TL}, 29(1), p. 5-8. +\doi{10.26034/la.atl.2011.443} + +Liritzis, I., Stamoulis, K., Papachristodoulou, C. & Ioannides, K. (2013). +A re-evaluation of radiation dose-rate conversion factors. +\emph{Mediterranean Archaeology and Archaeometry}, 12, p. 1–15. +} +\usage{ +data("heidelberg_2024") +} +\description{ +Reference data for the calibration sites near Heidelberg as detailed +in Kreutzer at al. (2025) +} +\references{ +Kreutzer, S., Martin, L., Miallier, D. & Mercier, N. (2025). +Environmental gamma dose rate measurements using cadmium zinc telluride (CZT) detectors. +\emph{Geochronology}, 7, p. 229–246. \doi{10.5194/gchron-7-229-2025} + +Kreutzer, S., Martin, L., Miallier, D., Mercier, N. & Faske, M. (2024). +Dataset: Environmental Gamma Dose Rate Measurements using CZT Detectors (1.0.0). +\emph{Zenodo}. \doi{10.5281/zenodo.13731839} +} +\seealso{ +Other datasets: +\code{\link{AIX_NaI_1}}, +\code{\link{BDX_LaBr_1}}, +\code{\link{HD_CZT_1}}, +\code{\link{clermont}}, +\code{\link{clermont_2024}} +} +\concept{datasets} +\keyword{datasets}