mspass::algorithms::amplitudes::BandwidthData Class Reference

Holds parameters defining a passband computed from snr. More...

#include <amplitudes.h>

Public Member Functions
double	bandwidth_fraction () const
double	bandwidth () const

Public Attributes
double	low_edge_f
double	high_edge_f
double	low_edge_snr
double	high_edge_snr
double	f_range

Detailed Description

Holds parameters defining a passband computed from snr.

This deconvolution operator has the option to determine the optimal shaping wavelet on the fly based on data bandwidth. This class is a struct in C++ disguise used to hold the encapsulation of the output of function(s) used to estimate the data bandwidth. This class is used only internally with CNR3CDecon to hold this information. It is not expected to be visible to python in MsPaSS, for example.

Constructor & Destructor Documentation

BandwidthData()

mspass::algorithms::amplitudes::BandwidthData::BandwidthData ( )

inline

                  {
    low_edge_f = 0.0;
    high_edge_f = 0.0;
    low_edge_snr = 0.0;
    high_edge_snr = 0.0;
    f_range = 0.0;
  };

Member Function Documentation

bandwidth()

double mspass::algorithms::amplitudes::BandwidthData::bandwidth ( ) const

inline

Return bandwidth in dB.

                           {
    /* All these conditionals are necessary for handling unexpected
     * values.   0 is effectively and error return.  Without these
     * the function can return NaN or generate floating point exceptions. */
    if ((f_range <= 0.0) || (high_edge_f<=low_edge_f)
      || (high_edge_f < 0.0) || (low_edge_f < 0.0) )
      return 0.0;
    else {
      double ratio = high_edge_f / low_edge_f;
      return 20.0 * log10(ratio);
    }
  };

References f_range, high_edge_f, and low_edge_f.

bandwidth_fraction()

double mspass::algorithms::amplitudes::BandwidthData::bandwidth_fraction ( ) const

inline

Return a metric of the estimated bandwidth divided by total frequency range

                                    {
    if (f_range <= 0.0)
      return 0.0;
    else
      return (high_edge_f - low_edge_f) / f_range;
  };

References f_range, high_edge_f, and low_edge_f.

Member Data Documentation

f_range

double mspass::algorithms::amplitudes::BandwidthData::f_range

Total frequency range of the original data used to normalize bandwidth.

high_edge_f

double mspass::algorithms::amplitudes::BandwidthData::high_edge_f

Upper corner frequency for band being defined.

high_edge_snr

double mspass::algorithms::amplitudes::BandwidthData::high_edge_snr

Signal to noise ratio at upper band edge.

low_edge_f

double mspass::algorithms::amplitudes::BandwidthData::low_edge_f

Low corner frequency for band being defined.

low_edge_snr

double mspass::algorithms::amplitudes::BandwidthData::low_edge_snr

Signal to noise ratio at lower band edge.

---

The documentation for this class was generated from the following file:

• /home/runner/work/mspass/mspass/cxx/include/mspass/algorithms/amplitudes.h