signal_stats: Calculate signal statistics
In eseis: Environmental Seismology Toolbox
signal_stats R Documentation
Calculate signal statistics
Description
This function calculates a set of statistics for the seismic signal
submitted.
Usage
signal_stats(data, stats, range_f, res_psd = 1, dt, cut = TRUE)
Arguments
data
eseis object, data set to be processed.
stats
Character vector, keywords of statistics to be
calculated. If omitted, all statistics will be calculated. Wrongly
spelled keywords will be omitted without warning.
range_f
Numerical vector of length two, range of the
frequency spectra used to calculate spectral properties. This is
recommended to account for spurious or unwanted frequency pars, for
example caused by ocean micro seism or high frequency effects.
res_psd
Numerical value, resolution of the spectrogram
used to calculate statistics, in seconds. Default is 1 sec. The
spectrogram will be calculated with 90
running window of 5 sec.
dt
Numeric value, sampling period. If omitted, dt
is set to 1/200.
cut
Logical value, option to cut output vector to the
required statistics, instead of returning the full length of statistics,
filled with NA values where no statistic was calculated. Default is
TRUE.
Details
Available statistics keywords are:
1. '"t_duration"' (Duration of the signal)
1. '"t_rise"' (Signal rise time, time from start to maximum amplitude)
1. '"t_fall"' (Signal fall time, tme from maximum amplitude to end)
1. '"t_risefall"' (Ratio of rise to fall time)
1. '"a_skewness"' (Skewness of the signal amplitude, see seewave::specprop)
1. '"a_kurtosis"' (Kurtosis of the signal amplitude, see seewave::specprop)
1. '"a1_kurtosis"' (Kurtosis of the filtered (0.1-1 Hz) signal amplitude, see seewave::specprop)
1. '"a2_kurtosis"' (Kurtosis of the filtered (1-3 Hz) signal amplitude, see seewave::specprop)
1. '"a3_kurtosis"' (Kurtosis of the filtered (3-10 Hz) signal amplitude, see seewave::specprop)
1. '"a4_kurtosis"' (Kurtosis of the filtered (10-20 Hz) signal amplitude, see seewave::specprop)
1. '"a5_kurtosis"' (Kurtosis of the filtered (20-50 Hz) signal amplitude, see seewave::specprop)
1. '"e_maxmean"' (Ratio of maximum and mean envelope value, see Hibert et al. (2017))
1. '"e_maxmedian"' (Ratio of maximum and median envelope value, see Hibert et al. (2017))
1. '"e_skewness"' (Skewness of the signal envelope, see seewave::specprop)
1. '"e_kurtosis"' (Kurtosis of the signal envelope, see seewave::specprop)
1. '"e1_logsum"' (Logarithm of the filtered (0.1-1 Hz) envelope sum, see Hibert et al. (2017))
1. '"e2_logsum"' (Logarithm of the filtered (1-3 Hz) envelope sum, see Hibert et al. (2017))
1. '"e3_logsum"' (Logarithm of the filtered (3-10 Hz) envelope sum, see Hibert et al. (2017))
1. '"e4_logsum"' (Logarithm of the filtered (10-20 Hz) envelope sum, see Hibert et al. (2017))
1. '"e5_logsum"' (Logarithm of the filtered (20-50 Hz) envelope sum, see Hibert et al. (2017))
1. '"e_rmsdecphaseline"' (RMS of envelope from linear decrease, see Hibert et al. (2017))
1. '"c_peaks"' (Number of peaks (excursions above 75
1. '"c_energy1"' (Sum of the first third of the signal cross correlation function, see Hibert et al. (2017))
1. '"c_energy2"' (Sum of the last two thirds of the signal cross correlation function, see Hibert et al. (2017))
1. '"c_energy3"' (Ratio of c_energy1 and c_energy2, see Hibert et al. (2017))
1. '"s_peaks"' (Number of peaks (excursions above 75
1. '"s_peakpower"' (Mean power of spectral peaks, see Hibert et al. (2017))
1. '"s_mean"' (Mean spectral power, see Hibert et al. (2017))
1. '"s_median"' (Median spectral power, see Hibert et al. (2017))
1. '"s_max"' (Maximum spectral power, see Hibert et al. (2017))
1. '"s_var"' (Variance of the spectral power, see Hibert et al. (2017))
1. '"s_sd"' (Standard deviation of the spectral power, see seewave::specprop)
1. '"s_sem"' (Standard error of the mean of the spectral power, see seewave::specprop)
1. '"s_flatness"' (Spectral flatness, see seewave::specprop)
1. '"s_entropy"' (Spectral entropy, see seewave::specprop)
1. '"s_precision"' (Spectral precision, see seewave::specprop)
1. '"s1_energy"' (Energy of the filtered (0.1-1 Hz) spectrum, see Hibert et al. (2017))
1. '"s2_energy"' (Energy of the filtered (1-3 Hz) spectrum, see Hibert et al. (2017))
1. '"s3_energy"' (Energy of the filtered (3-10 Hz) spectrum, see Hibert et al. (2017))
1. '"s4_energy"' (Energy of the filtered (10-20 Hz) spectrum, see Hibert et al. (2017))
1. '"s5_energy"' (Energy of the filtered (20-30 Hz) spectrum, see Hibert et al. (2017))
1. '"s_gamma1"' (Gamma 1, spectral centroid, see Hibert et al. (2017))
1. '"s_gamma2"' (Gamma 2, spectral gyration radius, see Hibert et al. (2017))
1. '"s_gamma3"' (Gamma 3, spectral centroid width, see Hibert et al. (2017))
1. '"f_modal"' (Modal frequency, see seewave::specprop)
1. '"f_mean"' (Mean frequency (aka central frequency), see seewave::specprop)
1. '"f_median"' (Median frequency, see seewave::specprop)
1. '"f_q05"' (Quantile 0.05 of the spectrum, see seewave::specprop)
1. '"f_q25"' (Quantile 0.25 of the spectrum, see seewave::specprop)
1. '"f_q75"' (Quantile 0.75 of the spectrum, see seewave::specprop)
1. '"f_q95"' (Quantile 0.95 of the spectrum, see seewave::specprop)
1. '"f_iqr"' (Inter quartile range of the spectrum, see seewave::specprop)
1. '"f_centroid"' (Spectral centroid, see seewave::specprop)
1. '"p_kurtosismax"' (Kurtosis of the maximum spectral power over time, see Hibert et al. (2017))
1. '"p_kurtosismedian"' (Kurtosis of the median spectral power over time, see Hibert et al. (2017))
1. '"p_maxmean"' (Mean of the ratio of max to mean spectral power over time, see Hibert et al. (2017))
1. '"p_maxmedian"' (Mean of the ratio of max to median spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmean"' (Number of peaks in normalised mean spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmedian"' (Number of peaks in normalised median spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmax"' (Number of peaks in normalised max spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmaxmean"' (Ratio of number of peaks in normalised max and mean spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmaxmedian"' (Ratio of number of peaks in normalised max and median spectral power over time, see Hibert et al. (2017))
1. '"p_peaksfcentral"' (Number of peaks in spectral power at central frequency over time, see Hibert et al. (2017))
1. '"p_diffmaxmean"' (Mean difference between max and mean power, see Hibert et al. (2017))
1. '"p_diffmaxmedian"' (Mean difference between max and median power, see Hibert et al. (2017))
1. '"p_diffquantile21"' (Mean difference between power quantiles 2 and 1, see Hibert et al. (2017))
1. '"p_diffquantile32"' (Mean difference between power quantiles 3 and 2, see Hibert et al. (2017))
1. '"p_diffquantile31"' (Mean difference between power quantiles 3 and 1, see Hibert et al. (2017))
References:
- Hibert C, Provost F, Malet J-P, Maggi A, Stumpf A, Ferrazzini V. 2017.
Automatic identification of rockfalls and volcano-tectonic earthquakes
at the Piton de la Fournaise volcano using a Random Forest algorithm.
Journal of Volcanology and Geothermal Research 340, 130-142.
Value
data frame with calculated statsitics
Author(s)
Michael Dietze
Examples
## load example data
data(rockfall)
## clip data to event of interest
eq <- signal_clip(data = rockfall_eseis,
limits = as.POSIXct(c("2015-04-06 13:18:50",
"2015-04-06 13:20:10"),
tz = "UTC"))
## calculate full statistics
eq_stats <- signal_stats(data = eq)
## show names of statistics
names(eq_stats)
## calculate and show selected statistics, with truncated frequency range
eq_stats_sub <- signal_stats(data = eq,
stats = c("t_rise",
"c_peaks",
"f_centroid"),
range_f = c(1, 90))
print(eq_stats_sub)
eseis documentation built on April 3, 2025, 10:57 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| signal_stats | R Documentation |
Calculate signal statistics
Description
This function calculates a set of statistics for the seismic signal submitted.
Usage
signal_stats(data, stats, range_f, res_psd = 1, dt, cut = TRUE)
Arguments
data |
|
stats |
|
range_f |
|
res_psd |
|
dt |
|
cut |
|
Details
Available statistics keywords are:
1. '"t_duration"' (Duration of the signal)
1. '"t_rise"' (Signal rise time, time from start to maximum amplitude)
1. '"t_fall"' (Signal fall time, tme from maximum amplitude to end)
1. '"t_risefall"' (Ratio of rise to fall time)
1. '"a_skewness"' (Skewness of the signal amplitude, see seewave::specprop)
1. '"a_kurtosis"' (Kurtosis of the signal amplitude, see seewave::specprop)
1. '"a1_kurtosis"' (Kurtosis of the filtered (0.1-1 Hz) signal amplitude, see seewave::specprop)
1. '"a2_kurtosis"' (Kurtosis of the filtered (1-3 Hz) signal amplitude, see seewave::specprop)
1. '"a3_kurtosis"' (Kurtosis of the filtered (3-10 Hz) signal amplitude, see seewave::specprop)
1. '"a4_kurtosis"' (Kurtosis of the filtered (10-20 Hz) signal amplitude, see seewave::specprop)
1. '"a5_kurtosis"' (Kurtosis of the filtered (20-50 Hz) signal amplitude, see seewave::specprop)
1. '"e_maxmean"' (Ratio of maximum and mean envelope value, see Hibert et al. (2017))
1. '"e_maxmedian"' (Ratio of maximum and median envelope value, see Hibert et al. (2017))
1. '"e_skewness"' (Skewness of the signal envelope, see seewave::specprop)
1. '"e_kurtosis"' (Kurtosis of the signal envelope, see seewave::specprop)
1. '"e1_logsum"' (Logarithm of the filtered (0.1-1 Hz) envelope sum, see Hibert et al. (2017))
1. '"e2_logsum"' (Logarithm of the filtered (1-3 Hz) envelope sum, see Hibert et al. (2017))
1. '"e3_logsum"' (Logarithm of the filtered (3-10 Hz) envelope sum, see Hibert et al. (2017))
1. '"e4_logsum"' (Logarithm of the filtered (10-20 Hz) envelope sum, see Hibert et al. (2017))
1. '"e5_logsum"' (Logarithm of the filtered (20-50 Hz) envelope sum, see Hibert et al. (2017))
1. '"e_rmsdecphaseline"' (RMS of envelope from linear decrease, see Hibert et al. (2017))
1. '"c_peaks"' (Number of peaks (excursions above 75
1. '"c_energy1"' (Sum of the first third of the signal cross correlation function, see Hibert et al. (2017))
1. '"c_energy2"' (Sum of the last two thirds of the signal cross correlation function, see Hibert et al. (2017))
1. '"c_energy3"' (Ratio of c_energy1 and c_energy2, see Hibert et al. (2017))
1. '"s_peaks"' (Number of peaks (excursions above 75
1. '"s_peakpower"' (Mean power of spectral peaks, see Hibert et al. (2017))
1. '"s_mean"' (Mean spectral power, see Hibert et al. (2017))
1. '"s_median"' (Median spectral power, see Hibert et al. (2017))
1. '"s_max"' (Maximum spectral power, see Hibert et al. (2017))
1. '"s_var"' (Variance of the spectral power, see Hibert et al. (2017))
1. '"s_sd"' (Standard deviation of the spectral power, see seewave::specprop)
1. '"s_sem"' (Standard error of the mean of the spectral power, see seewave::specprop)
1. '"s_flatness"' (Spectral flatness, see seewave::specprop)
1. '"s_entropy"' (Spectral entropy, see seewave::specprop)
1. '"s_precision"' (Spectral precision, see seewave::specprop)
1. '"s1_energy"' (Energy of the filtered (0.1-1 Hz) spectrum, see Hibert et al. (2017))
1. '"s2_energy"' (Energy of the filtered (1-3 Hz) spectrum, see Hibert et al. (2017))
1. '"s3_energy"' (Energy of the filtered (3-10 Hz) spectrum, see Hibert et al. (2017))
1. '"s4_energy"' (Energy of the filtered (10-20 Hz) spectrum, see Hibert et al. (2017))
1. '"s5_energy"' (Energy of the filtered (20-30 Hz) spectrum, see Hibert et al. (2017))
1. '"s_gamma1"' (Gamma 1, spectral centroid, see Hibert et al. (2017))
1. '"s_gamma2"' (Gamma 2, spectral gyration radius, see Hibert et al. (2017))
1. '"s_gamma3"' (Gamma 3, spectral centroid width, see Hibert et al. (2017))
1. '"f_modal"' (Modal frequency, see seewave::specprop)
1. '"f_mean"' (Mean frequency (aka central frequency), see seewave::specprop)
1. '"f_median"' (Median frequency, see seewave::specprop)
1. '"f_q05"' (Quantile 0.05 of the spectrum, see seewave::specprop)
1. '"f_q25"' (Quantile 0.25 of the spectrum, see seewave::specprop)
1. '"f_q75"' (Quantile 0.75 of the spectrum, see seewave::specprop)
1. '"f_q95"' (Quantile 0.95 of the spectrum, see seewave::specprop)
1. '"f_iqr"' (Inter quartile range of the spectrum, see seewave::specprop)
1. '"f_centroid"' (Spectral centroid, see seewave::specprop)
1. '"p_kurtosismax"' (Kurtosis of the maximum spectral power over time, see Hibert et al. (2017))
1. '"p_kurtosismedian"' (Kurtosis of the median spectral power over time, see Hibert et al. (2017))
1. '"p_maxmean"' (Mean of the ratio of max to mean spectral power over time, see Hibert et al. (2017))
1. '"p_maxmedian"' (Mean of the ratio of max to median spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmean"' (Number of peaks in normalised mean spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmedian"' (Number of peaks in normalised median spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmax"' (Number of peaks in normalised max spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmaxmean"' (Ratio of number of peaks in normalised max and mean spectral power over time, see Hibert et al. (2017))
1. '"p_peaksmaxmedian"' (Ratio of number of peaks in normalised max and median spectral power over time, see Hibert et al. (2017))
1. '"p_peaksfcentral"' (Number of peaks in spectral power at central frequency over time, see Hibert et al. (2017))
1. '"p_diffmaxmean"' (Mean difference between max and mean power, see Hibert et al. (2017))
1. '"p_diffmaxmedian"' (Mean difference between max and median power, see Hibert et al. (2017))
1. '"p_diffquantile21"' (Mean difference between power quantiles 2 and 1, see Hibert et al. (2017))
1. '"p_diffquantile32"' (Mean difference between power quantiles 3 and 2, see Hibert et al. (2017))
1. '"p_diffquantile31"' (Mean difference between power quantiles 3 and 1, see Hibert et al. (2017))
References: - Hibert C, Provost F, Malet J-P, Maggi A, Stumpf A, Ferrazzini V. 2017. Automatic identification of rockfalls and volcano-tectonic earthquakes at the Piton de la Fournaise volcano using a Random Forest algorithm. Journal of Volcanology and Geothermal Research 340, 130-142.
Value
data frame with calculated statsitics
Author(s)
Michael Dietze
Examples
## load example data
data(rockfall)
## clip data to event of interest
eq <- signal_clip(data = rockfall_eseis,
limits = as.POSIXct(c("2015-04-06 13:18:50",
"2015-04-06 13:20:10"),
tz = "UTC"))
## calculate full statistics
eq_stats <- signal_stats(data = eq)
## show names of statistics
names(eq_stats)
## calculate and show selected statistics, with truncated frequency range
eq_stats_sub <- signal_stats(data = eq,
stats = c("t_rise",
"c_peaks",
"f_centroid"),
range_f = c(1, 90))
print(eq_stats_sub)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.