TimeSeries.h

Go to the documentation of this file.

#ifndef CTIMSERIES_H
#define CTIMSERIES_H
#include "FatalException.h"
#include "TimeSeriesComponent.h"
#include <boost/date_time/posix_time/posix_time_types.hpp>
#include <vector>

namespace gplib
  {
    /** \addtogroup mttools MT data analysis, processing and inversion */
    /* @{ */

    //! This class is the base class for all classes dealing with MT time series
    class TimeSeries
      {
    public:
      //! We use the boost library time functionality for time types and store the time for each point in a vector
      typedef boost::posix_time::ptime ttime;
      typedef std::vector<ttime> ttimedata;
    protected:
      //! The data for the north-south magnetic field
      TimeSeriesComponent Hx;
      //! The data for the east-west magnetic field
      TimeSeriesComponent Hy;
      //! The data for the vertical magnetic field
      TimeSeriesComponent Hz;
      //! The data for the north-south electric field
      TimeSeriesComponent Ex;
      //! The data for the east-west electric field
      TimeSeriesComponent Ey;
      //! The time associated with each data point
      ttimedata t;
    public:
      //! Access function for Hx, returns reference for efficiency
      TimeSeriesComponent &GetHx()
        {
          return Hx;
        }
      TimeSeriesComponent &GetHy()
        {
          return Hy;
        }
      TimeSeriesComponent &GetHz()
        {
          return Hz;
        }
      TimeSeriesComponent &GetEx()
        {
          return Ex;
        }
      TimeSeriesComponent &GetEy()
        {
          return Ey;
        }
      ttimedata &GetTime()
        {
          return t;
        }
      //! Return the size of the time series, throws if one of the components has a different size
      size_t Size();
      /*! Declaration for GetData() that reads data from
       * a file. This is intended for use with external data, such as
       * recorded data, or synthetic data from external programs.
       */
      virtual void GetData(const std::string filename) = 0;
      /*! The abstract declaration for a method that writes the data to
       * a file. Therefore no version without a filename is present
       */
      virtual void WriteData(const std::string filename) = 0;
      //! The samplerate is stored in each component, we just return the samplerate of Hx assuming they are all equal
      double GetSamplerate()
        {
          const double samplerate = Hx.GetSamplerate();
          if (samplerate != Hy.GetSamplerate() || samplerate
              != Hz.GetSamplerate() || samplerate != Ex.GetSamplerate()
              || samplerate != Ey.GetSamplerate())
            throw FatalException("Samplerate is not equal for all components");
          return samplerate;
        }
      TimeSeries();
      virtual ~TimeSeries();
      TimeSeries& operator=(const TimeSeries &source);
      //! Multiply all components by a constant factor
      TimeSeries& operator*=(const double &factor);
      //! Add a constant shift to all components
      TimeSeries& operator+=(const double &shift);
      //! Erase data between startindex and endindex
      void erase(const int startindex, const int endindex);
      //friend void Synchronize(TimeSeries &Data1, TimeSeries &Data2);
      };

    /*! Synchronize two Objects containing MT data so that they have the same start time
     */
    void Synchronize(TimeSeries &Data1, TimeSeries &Data2);
  /* @} */
  }
#endif