gnsstk::PoleTides Class Reference

Detailed Description

This class computes the effect of pole tides, or more properly called "rotational deformations due to polar motion", at a given position and epoch.

The model used is the one proposed by the "International Earth Rotation and Reference Systems Service" (IERS) in its upcomming "IERS Conventions" document (Chapter 7), available at:

http://tai.bipm.org/iers/convupdt/convupdt.html

The pole movement parameters x, y for a given epoch may be found at:

ftp://hpiers.obspm.fr/iers/eop/eop.others

Maximum displacements because of this effect are:

• Vertical: 2.5 cm
• Horizontal: 0.7 cm

For additional information you may consult: Wahr, J.M., 1985, "Deformation Induced by Polar Motion", Journal of Geophysical Research, Vol. 90, No B11, p. 9363-9368.

Warning

Please take into account that pole tide equations in IERS document use co-latitude instead of latitude.

Definition at line 91 of file PoleTides.hpp.

#include <PoleTides.hpp>

Public Member Functions
Triple	getPoleTide (const CommonTime &t, const Position &p)
Triple	getPoleTide (const CommonTime &t, const Position &p, const double &x, const double &y)
double	getX (void) const
	Method to get the x pole displacement parameter, in arcseconds. More...
double	getY (void) const
	Method to get the y pole displacement parameter, in arcseconds. More...
	PoleTides ()
	Default constructor. Sets zero pole displacement. More...
	PoleTides (const double &x, const double &y)
PoleTides &	setXY (const double &x, const double &y)
virtual	~PoleTides ()
	Destructor. More...

Private Attributes
double	xdisp
	Pole displacement x, in arcseconds. More...
double	ydisp
	Pole displacement y, in arcseconds. More...

Constructor & Destructor Documentation

PoleTides() [1/2]

gnsstk::PoleTides::PoleTides ( )

inline

Default constructor. Sets zero pole displacement.

Definition at line 96 of file PoleTides.hpp.

PoleTides() [2/2]

gnsstk::PoleTides::PoleTides ( const double &  x, const double &  y  )

inline

Common constructor

Parameters

x	Pole displacement x, in arcseconds
y	Pole displacement y, in arcseconds

Definition at line 104 of file PoleTides.hpp.

~PoleTides()

virtual gnsstk::PoleTides::~PoleTides ( )

inlinevirtual

Destructor.

Definition at line 173 of file PoleTides.hpp.

Member Function Documentation

getPoleTide() [1/2]

Triple gnsstk::PoleTides::getPoleTide	(	const CommonTime &	t,
		const Position &	p
	)

Returns the effect of pole tides (meters) at the given position and epoch, in the Up-East-North (UEN) reference frame.

Parameters

[in]	t	Epoch to look up
[in]	p	Position of interest

Returns

a Triple with the pole tide effect, in meters and in the UEN reference frame.

Exceptions

InvalidRequest

If the request can not be completed for any reason, this is thrown. The text may have additional information about the reason the request failed.

Warning

In order to use this method, you must have previously set the current pole displacement parameters.

Definition at line 69 of file PoleTides.cpp.

getPoleTide() [2/2]

Triple gnsstk::PoleTides::getPoleTide ( const CommonTime &  t, const Position &  p, const double &  x, const double &  y  )

inline

Returns the effect of pole tides (meters) on the given position, in the Up-East-North (UEN) reference frame.

Parameters

[in]	p	Position of interest
[in]	x	Pole displacement x, in arcseconds
[in]	y	Pole displacement y, in arcseconds

Returns

a Triple with the pole tide effect, in meters and in the UEN reference frame.

Exceptions

InvalidRequest

If the request can not be completed for any reason, this is thrown. The text may have additional information about the reason the request failed.

Definition at line 144 of file PoleTides.hpp.

getX()

double gnsstk::PoleTides::getX ( void  ) const

inline

Method to get the x pole displacement parameter, in arcseconds.

Definition at line 163 of file PoleTides.hpp.

getY()

double gnsstk::PoleTides::getY ( void  ) const

inline

Method to get the y pole displacement parameter, in arcseconds.

Definition at line 168 of file PoleTides.hpp.

setXY()

PoleTides & gnsstk::PoleTides::setXY	(	const double &	x,
		const double &	y
	)

Method to set the pole displacement parameters

Parameters

x	Pole displacement x, in arcseconds
y	Pole displacement y, in arcseconds

Returns

This same object

Definition at line 138 of file PoleTides.cpp.

Member Data Documentation

xdisp

double gnsstk::PoleTides::xdisp

private

Pole displacement x, in arcseconds.

Definition at line 173 of file PoleTides.hpp.

ydisp

double gnsstk::PoleTides::ydisp

private

Pole displacement y, in arcseconds.

Definition at line 184 of file PoleTides.hpp.

---

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

• PoleTides.hpp
• PoleTides.cpp