mspass::algorithms::TimeWindow Class Reference

Defines a time window. More...

#include <TimeWindow.h>

Public Member Functions
	TimeWindow ()
	TimeWindow (const double ts, const double te)
	TimeWindow (const TimeWindow &parent)
TimeWindow &	operator= (const TimeWindow &parent)
TimeWindow	shift (const double tshift) const
double	length ()

Public Attributes
double	start
double	end

Detailed Description

Defines a time window.

Time windows are a common concept in time series analysis and seismology in particular. The object definition here has no concept of a time standard. It simply defines an interval in terms of a pair of real numbers.

Constructor & Destructor Documentation

TimeWindow() [1/3]

mspass::algorithms::TimeWindow::TimeWindow ( )

inline

Default constructor.

               {
    start = 0.0;
    end = 1.0e99;
  };

References end, and start.

TimeWindow() [2/3]

mspass::algorithms::TimeWindow::TimeWindow ( const double  ts, const double  te  )

inline

Parameterized constructor.

Parameters

ts	- start time
te	- end time

                                               {
    start = ts;
    end = te;
  };

References end, and start.

TimeWindow() [3/3]

mspass::algorithms::TimeWindow::TimeWindow ( const TimeWindow &  parent )

inline

Standard copy constructor.

Parameters

parent

source window to copy.

                                       {
    start = parent.start;
    end = parent.end;
  }

References end, and start.

Member Function Documentation

length()

double mspass::algorithms::TimeWindow::length ( )

inline

Returns the window length

{ return (end - start); };

References end, and start.

operator=()

TimeWindow & mspass::algorithms::TimeWindow::operator= ( const TimeWindow &  parent )

inline

Standard assignment operator.

Parameters

parent

source window to assign from.

Returns

reference to this window after assignment.

                                                  {
    if (&parent != this) {
      start = parent.start;
      end = parent.end;
    }
    return *this;
  }

References end, and start.

shift()

TimeWindow mspass::algorithms::TimeWindow::shift ( const double  tshift ) const

inline

Returns a new time window translated by tshift argument.

                                              {
    TimeWindow newwindow(*this);
    newwindow.start += tshift;
    newwindow.end += tshift;
    return (newwindow);
  }

References end, and start.

Member Data Documentation

end

double mspass::algorithms::TimeWindow::end

End time of the window.

start

double mspass::algorithms::TimeWindow::start

Start time of the window.

---

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

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