McNamaraBins: McNamara Binning

Description Usage Arguments Details Value Author(s) References See Also

View source: R/spectralUtils.R

Description

The McNamaraBins() function implements the binning algorithm specified in the "Data Preparation and Processing" section of Seismic Noise Analysis System Using Power Spectral Density Probability Density Functions.

Usage

1
McNamaraBins(df, loFreq, hiFreq, alignFreq)

Arguments

df

an R dataframe object

loFreq

optional lo end of frequency binning range (default=.005)

hiFreq

optional hi end of frequency binning range (default=10)

alignFreq

optional alignment frequency for determining frequency bins (default=0.1)

Details

The McNamaraBins() function accepts a dataframe with an arbitrary number of columns. At least one of the columns must be named 'freq' and must contain frequency values. These frequencies will be used to assign all associated values into appropriate bins according to the McNamara algorithm:

Frequencies for binning are generated at 1/8 octave intervals aligned to alignFreq. Binned values associated with each frequency bin are calculated by averaging incoming values over an entire octave centered on that frequency.

Value

A dataframe containing binned values is returned with the same column names as the incoming df argument.

Author(s)

Jonathan Callahan jonathan@mazamascience.com

References

Seismic Noise Analysis System Using Power Spectral Density Probability Density Functions (McNamara and Boaz 2005)

See Also

McNamaraPSD


IRISSeismic documentation built on Oct. 7, 2021, 9:10 a.m.