TS++ library: time series library
ts::TimeSeries< S, H > Struct Template Reference

Structure to hold the data samples of a series together with header information to form a time series. More...

#include <tsxx.h>

Inheritance diagram for ts::TimeSeries< S, H >:
Collaboration diagram for ts::TimeSeries< S, H >:

Public Types

Type definitions.

Header data and series shape can be declared invariable by application of the const qualifier. This is not the case for samples, being addressed through the series with handle semantics.

typedef S Tseries
 
typedef H Theader
 
typedef Tseries::Tvalue Tvalue
 
typedef TimeSeries< Tseries, TheaderTtimeseries
 
typedef TimeSeries< typename Tseries::Tcoc, TheaderTconsttimeseries
 

Public Member Functions

Constructors.

Conversion constructors are declared explicit, to avoid confusion, in mutual assignments of different class derived from this template. They all are a valid Tseries by definition.

 TimeSeries ()
 
 TimeSeries (const Tseries &s, const Theader &h)
 
 TimeSeries (const Ttimeseries &s)
 
Assignment operators.
Ttimeseriesoperator= (const Tseries &s)
 assign series to time series More...
 
Ttimeseriesoperator= (const Tvalue &v)
 set values of series in time series More...
 
Type conversion.
 operator Tconsttimeseries () const
 

Public Attributes

Theader header
 data header fields More...
 

Detailed Description

template<class S, class H>
struct ts::TimeSeries< S, H >

Structure to hold the data samples of a series together with header information to form a time series.

Relevant information to be contained in the header:

  • date and time of first sample
  • sampling interval
  • station, channel, etc. identifiers

The first two are necessary for time series processing, like filtering or application of tapers and windows. The third is relevant for keeping track of the data source. The most natural choice for the header structure appears to be an sff::WID2 header. Consequently we provide typdefs for these combinations of samples and header.

Note
ts::TimeSeries is derived from the series base class. Thus TimesSeries is a full series and can directly be fed to functions that take series as their arguments.

There are no hidden (private) parts of this class. Consequently it is defined to be a struct.

Definition at line 83 of file tsxx.h.


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