GPLIB++
Classes | Typedefs | Enumerations | Functions | Variables
MT data analysis, processing and inversion

Classes

class  gplib::C1DAnisoMTSynthData
 Calculate response of a 1D anisotropic model, code is based on Pek and Santos fortran code. More...
 
class  gplib::C1DMTSynthData
 Calculate synthetic MT data for a 1D model using Cagniard's algorithm. More...
 
class  gplib::ThreeDMTModel
 The class 3DMTModel manages 3D models for magnetotelluric model calculations, at this point this is only for file management and plotting purposes. More...
 
class  gplib::MagneticTF
 Store th local magnetic transfer function (tipper) More...
 
class  gplib::MTStation
 The class MTStation is used to store the transfer functions and related information for a MT-site. More...
 
class  gplib::MTStationList
 MTStationList holds a number of MTSites, usually associated with a single project, line, etc. More...
 
class  gplib::MTTensor
 Stores MT-Tensor components at a single frequency, calculates derived quantities. More...
 
class  gplib::PTensorMTData
 This class is for the special case where we only have phase tensor data and errors, but not the full impedance. More...
 
class  gplib::PTensorMTStation
 
class  gplib::BirrpAsciiFormat
 BirrpAsciiFormat reads and stores MT data in the ascii format used by the birrp processing software. More...
 
class  gplib::CsvFormat
 This class reads and writes data from Comma Separated Files CSV as produced by Excel etc. this particular flavour. More...
 
class  gplib::LemiTsFormat
 Read and write ascii files produced by the LEMI instruments. More...
 
class  gplib::MtuFilter
 Store the filter coefficients for one component of Phoenix mtu data. More...
 
class  gplib::MtuFormat
 Read and write phoenix mtu binary files. More...
 
class  gplib::TimeSeries
 This class is the base class for all classes dealing with MT time series. More...
 
class  gplib::TimeSeriesData
 TimeSeriesData stores a pointer to the different components of magnetotelluric data and provides functions to read and write it to files. More...
 

Typedefs

typedef std::vector< MTStation > gplib::tStationList
 
typedef std::vector< std::pair
< MTStation *, MTStation * > > 
gplib::tStatSyncPair
 

Enumerations

enum  gplib::ttsdatatype {
  gplib::tsunknown, gplib::mtu, gplib::birrp, gplib::csv,
  gplib::lemi
}
 ttsdatatype is used to store the source the data was read from More...
 

Functions

tStatSyncPair gplib::FindCorrespondingSites (tStationList &MasterList, tStationList &SlaveList)
 Take two different site Lists of arguments and return a vector of pairs that point to the sites that correspond to each other. More...
 
double gplib::Alpha_phi (const double phi11, const double phi12, const double phi21, const double phi22)
 return the phase tensor rotation angle as a function of the four phase tensor elements More...
 
double gplib::Beta_phi (const double phi11, const double phi12, const double phi21, const double phi22)
 return the phase tensor skew angle as a function of the four phase tensor elements More...
 
double gplib::Pi1 (const double phi11, const double phi12, const double phi21, const double phi22)
 return the phase tensor rotational invariant $ \Pi_1 $ as a function of the four phase tensor elements More...
 
double gplib::Pi2 (const double phi11, const double phi12, const double phi21, const double phi22)
 return the phase tensor rotational invariant $ \Pi_2 $ as a function of the four phase tensor elements More...
 
double gplib::PhiStrike (const double phi11, const double phi12, const double phi21, const double phi22)
 return the phase tensor strike angle as a function of the four phase tensor elements More...
 
double gplib::PhiMax (const double phi11, const double phi12, const double phi21, const double phi22)
 Return the maximum principal component of the phase tensor. More...
 
double gplib::PhiMin (const double phi11, const double phi12, const double phi21, const double phi22)
 Return the mimum principal component of the phase tensor. More...
 
double gplib::trPhi (const double phi11, const double phi12, const double phi21, const double phi22)
 Return the trace of the phase tensor. More...
 
double gplib::skPhi (const double phi11, const double phi12, const double phi21, const double phi22)
 Return the skew of the phase tensor. More...
 
double gplib::detPhi (const double phi11, const double phi12, const double phi21, const double phi22)
 Return the determinant of the phase tensor. More...
 
double gplib::Phi1 (const double phi11, const double phi12, const double phi21, const double phi22)
 
double gplib::Phi2 (const double phi11, const double phi12, const double phi21, const double phi22)
 
double gplib::GetPhi2Sq (const double phi11, const double phi12, const double phi21, const double phi22)
 
double gplib::GetPhi3 (const double phi11, const double phi12, const double phi21, const double phi22)
 
double gplib::GetPhiEllip (const double phi11, const double phi12, const double phi21, const double phi22)
 Return the ellipticity of the phase tensor. More...
 
void gplib::Synchronize (TimeSeries &Data1, TimeSeries &Data2)
 Synchronize only works for continuous data at this point. More...
 
bool gplib::IsSpikeAbsolute (const double prediff, const double postdiff, const double currvalue, const double Threshold)
 
bool gplib::IsSpikePreRel (const double prediff, const double postdiff, const double currvalue, const double Threshold)
 
bool gplib::IsSpikePostRel (const double prediff, const double postdiff, const double currvalue, const double Threshold)
 
bool gplib::IsSpikeAnyRel (const double prediff, const double postdiff, const double currvalue, const double Threshold)
 
bool gplib::IsSpikeBothRel (const double prediff, const double postdiff, const double currvalue, const double Threshold)
 

Variables

const std::map< std::string,
MTStation::tmtdataformat > 
gplib::MTFileTypes
 

Detailed Description

/file This header file provides some function to calculate phase tensor quantities that are used in MTTensor and PTensorMTData

Typedef Documentation

typedef std::vector<MTStation> gplib::tStationList

Definition at line 14 of file MTStationList.h.

typedef std::vector<std::pair<MTStation*, MTStation*> > gplib::tStatSyncPair

Definition at line 57 of file MTStationList.h.

Enumeration Type Documentation

ttsdatatype is used to store the source the data was read from

Enumerator
tsunknown 
mtu 
birrp 
csv 
lemi 

Definition at line 13 of file TimeSeriesData.h.

Function Documentation

double gplib::Alpha_phi ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

return the phase tensor rotation angle as a function of the four phase tensor elements

Definition at line 17 of file ptfuncs.h.

Referenced by gplib::PhiStrike().

double gplib::Beta_phi ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

return the phase tensor skew angle as a function of the four phase tensor elements

Definition at line 23 of file ptfuncs.h.

Referenced by gplib::PhiStrike().

double gplib::detPhi ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Return the determinant of the phase tensor.

Definition at line 74 of file ptfuncs.h.

Referenced by gplib::GetPhi2Sq(), and gplib::Phi2().

tStatSyncPair gplib::FindCorrespondingSites ( tStationList &  MasterList,
tStationList &  SlaveList 
)

Take two different site Lists of arguments and return a vector of pairs that point to the sites that correspond to each other.

Definition at line 160 of file MTStationList.cpp.

Referenced by main().

double gplib::GetPhi2Sq ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Definition at line 92 of file ptfuncs.h.

References gplib::detPhi().

double gplib::GetPhi3 ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Definition at line 98 of file ptfuncs.h.

References gplib::skPhi().

Referenced by main().

double gplib::GetPhiEllip ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Return the ellipticity of the phase tensor.

Definition at line 104 of file ptfuncs.h.

References gplib::PhiMax(), and gplib::PhiMin().

Referenced by main().

bool gplib::IsSpikeAbsolute ( const double  prediff,
const double  postdiff,
const double  currvalue,
const double  Threshold 
)
inline

Definition at line 8 of file tsfuncs.h.

bool gplib::IsSpikeAnyRel ( const double  prediff,
const double  postdiff,
const double  currvalue,
const double  Threshold 
)
inline

Definition at line 35 of file tsfuncs.h.

bool gplib::IsSpikeBothRel ( const double  prediff,
const double  postdiff,
const double  currvalue,
const double  Threshold 
)
inline

Definition at line 45 of file tsfuncs.h.

bool gplib::IsSpikePostRel ( const double  prediff,
const double  postdiff,
const double  currvalue,
const double  Threshold 
)
inline

Definition at line 26 of file tsfuncs.h.

bool gplib::IsSpikePreRel ( const double  prediff,
const double  postdiff,
const double  currvalue,
const double  Threshold 
)
inline

Definition at line 17 of file tsfuncs.h.

double gplib::Phi1 ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Definition at line 80 of file ptfuncs.h.

References gplib::trPhi().

double gplib::Phi2 ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Definition at line 86 of file ptfuncs.h.

References gplib::detPhi().

double gplib::PhiMax ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Return the maximum principal component of the phase tensor.

Definition at line 48 of file ptfuncs.h.

References gplib::Pi1(), and gplib::Pi2().

Referenced by gplib::GetPhiEllip().

double gplib::PhiMin ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Return the mimum principal component of the phase tensor.

Definition at line 55 of file ptfuncs.h.

References gplib::Pi1(), and gplib::Pi2().

Referenced by gplib::GetPhiEllip().

double gplib::PhiStrike ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

return the phase tensor strike angle as a function of the four phase tensor elements

Definition at line 41 of file ptfuncs.h.

References gplib::Alpha_phi(), and gplib::Beta_phi().

double gplib::Pi1 ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

return the phase tensor rotational invariant $ \Pi_1 $ as a function of the four phase tensor elements

Definition at line 29 of file ptfuncs.h.

Referenced by gplib::PhiMax(), and gplib::PhiMin().

double gplib::Pi2 ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

return the phase tensor rotational invariant $ \Pi_2 $ as a function of the four phase tensor elements

Definition at line 35 of file ptfuncs.h.

Referenced by gplib::PhiMax(), and gplib::PhiMin().

double gplib::skPhi ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Return the skew of the phase tensor.

Definition at line 68 of file ptfuncs.h.

Referenced by gplib::GetPhi3().

void gplib::Synchronize ( TimeSeries &  Data1,
TimeSeries &  Data2 
)

Synchronize only works for continuous data at this point.

Synchronize two Objects containing MT data so that they have the same start time

Definition at line 88 of file TimeSeries.cpp.

References gplib::TimeSeries::erase(), gplib::TimeSeries::GetSamplerate(), and gplib::TimeSeries::GetTime().

double gplib::trPhi ( const double  phi11,
const double  phi12,
const double  phi21,
const double  phi22 
)
inline

Return the trace of the phase tensor.

Definition at line 62 of file ptfuncs.h.

Referenced by gplib::Phi1().

Variable Documentation

const std::map<std::string, MTStation::tmtdataformat> gplib::MTFileTypes
Initial value:
=
{
{ ".mtt", MTStation::tmtdataformat::mtt},
{ ".j", MTStation::tmtdataformat::j},
{ ".dat", MTStation::tmtdataformat::j},
{ ".nc", MTStation::tmtdataformat::nc},
{ ".zmm", MTStation::tmtdataformat::zmm},
{ ".mtf", MTStation::tmtdataformat::mtf},
{ ".edi", MTStation::tmtdataformat::edi},
{ ".pek", MTStation::tmtdataformat::pek}
}

Definition at line 157 of file MTStation.h.

Referenced by gplib::MTStation::GetData().