signal_snr {eseis} | R Documentation |
Calculate signal-to-noise-ratio (SNR).
Description
The function calculates the signal-to-noise ratio of an input signal vector as the ratio between mean and max.
Usage
signal_snr(
data,
scale = "lin",
detrend = FALSE,
envelope = FALSE,
method = "max-mean"
)
Arguments
data |
|
scale |
|
detrend |
|
envelope |
|
method |
|
Value
Numeric
value, signal-to-noise ratio.
Author(s)
Michael Dietze
Examples
## load example data set
data(rockfall)
## remove mean and calculate envelope beforehand
x_prep <- signal_envelope(signal_detrend(rockfall_eseis))
## calculate snr
snr <- signal_snr(data = x_prep)
print(snr$snr)
## calculate snr with preprocessing during function call, and in dB scale
snr_dB <- signal_snr(data = rockfall_eseis, detrend = TRUE,
envelope = TRUE, scale = "dB")
print(snr_dB$snr)
[Package eseis version 0.8.1 Index]