calc_DoseRate: Estimate the in-situ wet gamma dose rate

Description Usage Arguments Value Examples

View source: R/calc_DoseRate.R

Description

This function estimates the in-situ gamma dose rate of the provided gamma spectrum based on the recorded countrate and comparing the integrated sum to that of an internal calibration spectrum.

Usage

1
2
3
calc_DoseRate(data, energy.min = get_EnergyThreshold(),
  energy.max = NULL, background.correction = TRUE, plot = TRUE,
  plot.combine = TRUE, app = FALSE, ...)

Arguments

data

required: An SPE file imported with read_SPE

energy.min

numeric (default: 500): Lower integration limit of the photon energy (keV).

energy.max

numeric (optional): upper integration limit of the photon energy (keV).

background.correction

logical (default: TRUE): If TRUE a background signal (included in this package) is subtracted from both the measured and the calibration spectrum.

plot

logical (default: TRUE): Show or hide the plot(s).

plot.combine

logical (default: TRUE): Combine all plots in a single plot device.

app

logical (default: FALSE): Start the shiny application (requires the the shiny package). If TRUE all other arguments are ignored.

...

Additional arguments: verbose. Further arguments to be passed to plot or, if app = TRUE, to runApp.

Value

Returns terminal output, a plot and a list.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Load Example Data
file <- system.file("extdata", "Nievenheim_DORNIE_1.spe", package = "gammaSpec")

## Import SPE files
spec <- read_SPE(file)

## Estimate the in-situ gamma dose rate
res <- calc_DoseRate(data = spec,
                     energy.min = 1000,
                     energy.max = 2000,
                     background.correction = TRUE,
                     plot = TRUE,
                     plot.combine = FALSE,
                     verbose = TRUE)
                     
print(res$summary)

tzerk/gammaSpec documentation built on May 3, 2019, 2:04 p.m.