BasicSpectrum.h

#ifndef _BASIC_SPECTRUM_H_
#define _BASIC_SPECTRUM_H_
#include "mspass/utility/MsPASSError.h"
#include <math.h>
#include <vector>
namespace mspass::seismic {
class BasicSpectrum {
public:
  BasicSpectrum() {
    dfval = 1.0;
    f0val = 0.0;
  };
  BasicSpectrum(const double dfin, const double f0in, const double dtin,
                const int npts_in) {
    is_live = false;
    dfval = dfin;
    f0val = f0in;
    parent_dt = dtin;
    parent_npts = npts_in;
  };
  BasicSpectrum(const BasicSpectrum &parent) {
    is_live = parent.is_live;
    dfval = parent.dfval;
    f0val = parent.f0val;
    parent_dt = parent.parent_dt;
    parent_npts = parent.parent_npts;
  };
  BasicSpectrum &operator=(const BasicSpectrum &parent) {
    if (this != (&parent)) {
      is_live = parent.is_live;
      dfval = parent.dfval;
      f0val = parent.f0val;
      parent_dt = parent.parent_dt;
      parent_npts = parent.parent_npts;
    }
    return *this;
  };
  /*~ Destructor.*/
  virtual ~BasicSpectrum() {};
  bool live() const { return is_live; };
  bool dead() const { return !is_live; };
  void kill() { is_live = false; };
  void set_live() { is_live = true; };
  double df() const { return this->dfval; };
  double f0() const { return this->f0val; };
  double dt() const { return this->parent_dt; };
  double rayleigh() const {
    return 1.0 / (this->parent_dt * static_cast<double>(this->parent_npts));
  };
  int timeseries_npts() const { return parent_npts; }
  int sample_number(const double f) const {
    int itest = static_cast<int>(round((f - f0val) / dfval));
    if (itest < 0) {
      throw mspass::utility::MsPASSError(
          "BasicSpectrum::sample_number:  f must be positive or greater than "
          "f0 if f0!=0",
          mspass::utility::ErrorSeverity::Fatal);
    } else if (itest >= this->nf()) {
      throw mspass::utility::MsPASSError(
          "BasicSpectrum::sample_number:  f received exceeds the length of "
          "stored vector",
          mspass::utility::ErrorSeverity::Fatal);
    } else {
      return itest;
    }
  };
  void set_df(const double dfin) { dfval = dfin; };
  void set_f0(const double f0in) { f0val = f0in; };
  void set_dt(const double dtin) { parent_dt = dtin; };
  void set_npts(const int npts_in) { parent_npts = npts_in; };
  virtual std::vector<double> frequencies() const = 0;
  virtual double frequency(const int sample_number) const = 0;
  virtual size_t nf() const = 0;
  virtual double Nyquist() const = 0;
 
protected:
  double dfval;
  double f0val;
  double parent_dt;
  double parent_npts;
  bool is_live;
};
} // namespace mspass::seismic
#endif