GPLIB++
Public Member Functions | List of all members
gplib::BirrpAsciiFormat Class Reference

BirrpAsciiFormat reads and stores MT data in the ascii format used by the birrp processing software. More...

#include <BirrpAsciiFormat.h>

Inheritance diagram for gplib::BirrpAsciiFormat:
Inheritance graph
[legend]

Public Member Functions

 BirrpAsciiFormat ()
 
 ~BirrpAsciiFormat ()
 
virtual void GetData (const std::string filename)
 Read data in birrp ascii format from a file called filename. More...
 
virtual void WriteData (const std::string filename)
 Write data in birrp ascii format to a file called filename. More...
 
BirrpAsciiFormatoperator= (BirrpAsciiFormat &source)
 
BirrpAsciiFormatoperator= (MtuFormat &source)
 
BirrpAsciiFormatoperator= (TimeSeries &source)
 
- Public Member Functions inherited from gplib::TimeSeries
TimeSeriesComponentGetHx ()
 Access function for Hx, returns reference for efficiency. More...
 
TimeSeriesComponentGetHy ()
 
TimeSeriesComponentGetHz ()
 
TimeSeriesComponentGetEx ()
 
TimeSeriesComponentGetEy ()
 
ttimedataGetTime ()
 
size_t Size ()
 Return the size of the time series, throws if one of the components has a different size. More...
 
double GetSamplerate ()
 The samplerate is stored in each component, we just return the samplerate of Hx assuming they are all equal. More...
 
 TimeSeries ()
 
virtual ~TimeSeries ()
 
TimeSeriesoperator= (const TimeSeries &source)
 
TimeSeriesoperator*= (const double &factor)
 Multiply all components by a constant factor. More...
 
TimeSeriesoperator+= (const double &shift)
 Add a constant shift to all components. More...
 
void erase (const int startindex, const int endindex)
 Erase data between startindex and endindex. More...
 

Additional Inherited Members

- Public Types inherited from gplib::TimeSeries
typedef boost::posix_time::ptime ttime
 We use the boost library time functionality for time types and store the time for each point in a vector. More...
 
typedef std::vector< ttimettimedata
 
- Protected Attributes inherited from gplib::TimeSeries
TimeSeriesComponent Hx
 The data for the north-south magnetic field. More...
 
TimeSeriesComponent Hy
 The data for the east-west magnetic field. More...
 
TimeSeriesComponent Hz
 The data for the vertical magnetic field. More...
 
TimeSeriesComponent Ex
 The data for the north-south electric field. More...
 
TimeSeriesComponent Ey
 The data for the east-west electric field. More...
 
ttimedata t
 The time associated with each data point. More...
 

Detailed Description

BirrpAsciiFormat reads and stores MT data in the ascii format used by the birrp processing software.

Definition at line 13 of file BirrpAsciiFormat.h.

Constructor & Destructor Documentation

gplib::BirrpAsciiFormat::BirrpAsciiFormat ( )

Definition at line 13 of file BirrpAsciiFormat.cpp.

gplib::BirrpAsciiFormat::~BirrpAsciiFormat ( )

Definition at line 16 of file BirrpAsciiFormat.cpp.

Member Function Documentation

void gplib::BirrpAsciiFormat::GetData ( const std::string  filename)
virtual

Read data in birrp ascii format from a file called filename.

Implements gplib::TimeSeries.

Definition at line 20 of file BirrpAsciiFormat.cpp.

BirrpAsciiFormat & gplib::BirrpAsciiFormat::operator= ( BirrpAsciiFormat source)

Definition at line 85 of file BirrpAsciiFormat.cpp.

BirrpAsciiFormat & gplib::BirrpAsciiFormat::operator= ( MtuFormat source)

Definition at line 94 of file BirrpAsciiFormat.cpp.

BirrpAsciiFormat & gplib::BirrpAsciiFormat::operator= ( TimeSeries source)

Definition at line 101 of file BirrpAsciiFormat.cpp.

void gplib::BirrpAsciiFormat::WriteData ( const std::string  filename)
virtual

Write data in birrp ascii format to a file called filename.

Implements gplib::TimeSeries.

Definition at line 56 of file BirrpAsciiFormat.cpp.

Referenced by gplib::TimeSeriesData::WriteAsBirrp().


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