BasicTimeSeries.h

#ifndef _BASICTIMESERIES_H_
#define _BASICTIMESERIES_H_
#include <boost/archive/text_iarchive.hpp>
#include <boost/archive/text_oarchive.hpp>
#include <math.h>
namespace mspass::seismic {
enum class TimeReferenceType {
  UTC,     
  Relative 
};
 
class BasicTimeSeries {
public:
  BasicTimeSeries();
  BasicTimeSeries(const BasicTimeSeries &);
  virtual ~BasicTimeSeries() {};
  double time(const int i) const {
    return (mt0 + mdt * static_cast<double>(i));
  };
  int sample_number(double t) const { return (round((t - mt0) / mdt)); };
  double endtime() const noexcept {
    return (mt0 + (static_cast<double>(nsamp) - 1.0) * mdt);
  };
  bool shifted() const { return t0shift_is_valid; };
  double get_t0shift() const { return this->t0shift; };
  double time_reference() const;
  void force_t0_shift(const double t) {
    this->t0shift = t;
    t0shift_is_valid = true;
  };
  virtual void ator(const double tshift);
  virtual void rtoa();
  virtual void shift(const double dt);
  bool live() const { return this->mlive; };
  bool dead() const { return !(this->mlive); };
  void kill() { this->mlive = false; };
  void set_live() { this->mlive = true; };
  double dt() const { return this->mdt; };
  bool time_is_UTC() const {
    if (tref == TimeReferenceType::UTC)
      return true;
    else
      return false;
  };
  bool time_is_relative() const {
    if (tref == TimeReferenceType::Relative)
      return true;
    else
      return false;
  };
  TimeReferenceType timetype() const { return this->tref; }
  double samprate() const { return 1.0 / mdt; }
  size_t npts() const { return nsamp; };
  double t0() const { return this->mt0; };
  std::vector<double> time_axis() const;
  virtual void set_dt(const double sample_interval) { mdt = sample_interval; };
  virtual void set_npts(const size_t npts) { nsamp = npts; };
  virtual void set_t0(const double t0in) { mt0 = t0in; };
  void set_tref(const TimeReferenceType newtref) { tref = newtref; };
  BasicTimeSeries &operator=(const BasicTimeSeries &parent);
 
protected:
  bool mlive;
  double mdt;
  double mt0;
  size_t nsamp;
  TimeReferenceType tref;
  /* We actually test for t0shift two ways.  If this is true we always accept
   * it. If false we check for nonzero t0shift and override if necessary.
   * */
  bool t0shift_is_valid;
  /*When ator or rtoa are called this variable defines the conversion back
   * and forth.  The shift method should be used to change it. */
  double t0shift;
 
private:
  friend boost::serialization::access;
  template <class Archive>
  void serialize(Archive &ar, const unsigned int version) {
    ar & mlive;
    ar & mdt;
    ar & nsamp;
    ar & mt0;
    ar & tref;
    ar & t0shift_is_valid;
    ar & t0shift;
  };
};
} // namespace mspass::seismic
#endif // End guard