integrate: Signal Integration

View source: R/signal_integrate.R

signal_integrateR Documentation

Signal Integration

Description

Signal Integration

Usage

signal_integrate(object, background, ...)

## S4 method for signature 'GammaSpectrum,missing'
signal_integrate(object, range = NULL, energy = FALSE)

## S4 method for signature 'GammaSpectrum,GammaSpectrum'
signal_integrate(object, background, range = NULL, energy = FALSE)

## S4 method for signature 'GammaSpectrum,numeric'
signal_integrate(object, background, range = NULL, energy = FALSE)

## S4 method for signature 'GammaSpectra,missing'
signal_integrate(object, range = NULL, energy = FALSE, simplify = TRUE)

## S4 method for signature 'GammaSpectra,GammaSpectrum'
signal_integrate(
  object,
  background,
  range = NULL,
  energy = FALSE,
  simplify = TRUE
)

## S4 method for signature 'GammaSpectra,numeric'
signal_integrate(
  object,
  background,
  range = NULL,
  energy = FALSE,
  simplify = TRUE
)

Arguments

object

A GammaSpectrum or GammaSpectra object.

background

A GammaSpectrum object.

...

Currently not used.

range

A length-two numeric vector giving the energy range to integrate within (in keV).

energy

A logical scalar: TODO?

simplify

A logical scalar: should the result be simplified to a matrix? The default value, FALSE, returns a list.

Details

It assumes that each spectrum has an energy scale.

Value

If simplify is FALSE (the default) returns a list of numeric vectors (the signal value and its error), else returns a matrix.

Author(s)

N. Frerebeau

References

Guérin, G. & Mercier, M. (2011). Determining Gamma Dose Rates by Field Gamma Spectroscopy in Sedimentary Media: Results of Monte Carlo Simulations. Radiation Measurements, 46(2), p. 190-195. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.radmeas.2010.10.003")}.

Mercier, N. & Falguères, C. (2007). Field Gamma Dose-Rate Measurement with a NaI(Tl) Detector: Re-Evaluation of the "Threshold" Technique. Ancient TL, 25(1), p. 1-4.

See Also

Other signal processing: baseline, peaks_find(), peaks_search(), signal_slice(), signal_split(), signal_stabilize(), smooth()


nfrerebeau/gamma documentation built on July 7, 2023, 11:19 a.m.