BLQDataReader Class Reference
[Formatted file I/O]

#include <BLQDataReader.hpp>

Inheritance diagram for BLQDataReader:

[legend]Collaboration diagram for BLQDataReader:

[legend]List of all members.

---

Detailed Description

This is a class to read and parse ocean tides harmonics data in BLQ file format.

Ocean loading displacement models usually use the ocean tide harmonics in order to compute station biases due to this effect.

A common format to encode such information is the so-called BLQ format, where each station name is associated to a matrix with 11 columns (corresponding to the most important harmonics) and six rows: Three for amplitudes (radial, west, south), and three for phases (radial, west, south).

You may find this data using the "Ocean tide loading provider" at:

http://www.oso.chalmers.se/~loading/

A typical way to use this class follows:

   BLQDataReader blqread;

   blqread.open("EBRE.GOT00.2");

   Matrix<double> tides(6,11,0.0);

   tides = blqread.getTideHarmonics("EBRE");

The eleven tide harmonics used are:

• M2: Principal lunar semidiurnal
• S2: Principal solar semidiurnal
• N2: Larger lunar elliptic semidiurnal
• K2: Lunisolar semidiurnal
• K1: Lunar diurnal
• O1: Lunar diurnal
• P1: Solar diurnal
• Q1: Larger lunar elliptic diurnal
• MF: Lunisolar fortnightly
• MM: Lunar monthly
• SSA: Solar semiannual

Warning:

Be aware that you may select several different tide models to generate tide harmonics. It is advised to use the latest models such as GOT00.2, FES99, TPXO.6.2, etc.

Definition at line 96 of file BLQDataReader.hpp.

Public Member Functions
	BLQDataReader ()
	Default constructor.
	BLQDataReader (const char *fn)
	Common constructor.
	BLQDataReader (const string &fn)
	Common constructor.
virtual void	open (const char *fn)
	Method to open AND load ocean tide harmonics data file.
virtual void	open (const string &fn)
	Method to open AND load ocean tide harmonics data file.
virtual BLQDataReader &	clearData ()
	Method to clear all previously loaded ocean tide harmonics data.
virtual Matrix< double >	getTideHarmonics (const string &station)
	Method to get the ocean tide harmonics corresponding to a given station.
virtual	~BLQDataReader ()
	Destructor.

---

Constructor & Destructor Documentation

BLQDataReader (   )  [inline]

Default constructor. Definition at line 101 of file BLQDataReader.hpp.

BLQDataReader (  const char *  fn  )  [inline]

Common constructor. It will always open file a for read and will load ocean tide harmonics data in one pass. Parameters: fn  BLQ data file to read Definition at line 110 of file BLQDataReader.hpp.

BLQDataReader (  const string &  fn  )  [inline]

Common constructor. It will always open file for read and will load ocean tide harmonics data in one pass. Parameters: fn  BLQ data file to read Definition at line 121 of file BLQDataReader.hpp.

virtual ~BLQDataReader (   )  [inline, virtual]

Destructor. Definition at line 156 of file BLQDataReader.hpp.

---

Member Function Documentation

virtual BLQDataReader& clearData (   )  [inline, virtual]

Method to clear all previously loaded ocean tide harmonics data. Definition at line 137 of file BLQDataReader.hpp.

Matrix< double > getTideHarmonics (  const string &  station  )  [virtual]

Method to get the ocean tide harmonics corresponding to a given station. Parameters: station  Station name (case is NOT relevant). Returns: A Matrix<double> of siw rows and eleven columns containing tide harmonics M2, S2, N2, K2, K1, O1, P1, Q1, MF, MM and SSA for amplitudes (radial, west, south, in meters) and phases (radial, west, south, in degrees). If station is not found, this method will return a matrix full of zeros. Definition at line 206 of file BLQDataReader.cpp.

void open (  const string &  fn  )  [virtual]

Method to open AND load ocean tide harmonics data file. It doesn't clear data previously loaded. Definition at line 180 of file BLQDataReader.cpp.

void open (  const char *  fn  )  [virtual]

Method to open AND load ocean tide harmonics data file. It doesn't clear data previously loaded. Definition at line 163 of file BLQDataReader.cpp. Referenced by OceanLoading::setFilename().

---

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

• BLQDataReader.hpp
• BLQDataReader.cpp

---