ScalarDecon.h

#ifndef __SIMPLE_DECON_H__
#define __SIMPLE_DECON_H__
 
#include "mspass/algorithms/deconvolution/BasicDeconOperator.h"
#include "mspass/algorithms/deconvolution/ShapingWavelet.h"
#include "mspass/seismic/CoreTimeSeries.h"
#include "mspass/utility/Metadata.h"
#include <vector>
 
#include <boost/archive/text_iarchive.hpp>
#include <boost/archive/text_oarchive.hpp>
#include <boost/serialization/vector.hpp>
 
namespace mspass::algorithms::deconvolution {
class ScalarDecon : public BasicDeconOperator {
public:
  ScalarDecon() : shapingwavelet() {};
  ScalarDecon(const mspass::utility::Metadata &md);
  ScalarDecon(const std::vector<double> &d, const std::vector<double> &w);
  ScalarDecon(const ScalarDecon &parent);
  int load(const std::vector<double> &wavelet, const std::vector<double> &data);
  int loaddata(const std::vector<double> &data);
  int loadwavelet(const std::vector<double> &wavelet);
  virtual void process() = 0;
  ~ScalarDecon() {};
  ScalarDecon &operator=(const ScalarDecon &parent);
  std::vector<double> getresult() { return result; };
  /* This method does nothing, but needs to be defined to avoid
   * gcc compile errors in programs using children of this class.*/
  void changeparameter(const mspass::utility::Metadata &md);
  void change_shaping_wavelet(const ShapingWavelet &nsw);
  ShapingWavelet get_shaping_wavelet() const { return this->shapingwavelet; };
  /* \brief Return the ideal output of the deconvolution operator.
 
  All deconvolution operators have a implicit or explicit ideal output
  signal. e.g. for a spiking Wiener filter it is a delta function with or
  without a lag.  For a shaping wavelt it is the time domain version of the
  wavelet. */
  mspass::seismic::CoreTimeSeries ideal_output() {
    return this->shapingwavelet.impulse_response();
  };
  virtual mspass::seismic::CoreTimeSeries actual_output() = 0;
 
  virtual mspass::seismic::CoreTimeSeries inverse_wavelet() = 0;
  virtual mspass::seismic::CoreTimeSeries inverse_wavelet(double) = 0;
  virtual mspass::utility::Metadata QCMetrics() = 0;
 
protected:
  std::vector<double> data;
  std::vector<double> wavelet;
  std::vector<double> result;
  ShapingWavelet shapingwavelet;
 
private:
  friend boost::serialization::access;
  template <class Archive>
  void serialize(Archive &ar, const unsigned int version) {
    ar & data;
    ar & wavelet;
    ar & result;
    ar & shapingwavelet;
  }
};
} // namespace mspass::algorithms::deconvolution
#endif