Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples | Search for 

PoleTides Class Reference
[GPS solution algorithms and Tropospheric]

#include <PoleTides.hpp>

List of all members.

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:

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 78 of file PoleTides.hpp.

Public Member Functions

 PoleTides ()
 Default constructor. Sets zero pole displacement.
 PoleTides (const double &x, const double &y)
 Common constructor.
Triple getPoleTide (const CommonTime &t, const Position &p) throw (InvalidRequest)
 Returns the effect of pole tides (meters) at the given position and epoch, in the Up-East-North (UEN) reference frame.
Triple getPoleTide (const CommonTime &t, const Position &p, const double &x, const double &y) throw (InvalidRequest)
 Returns the effect of pole tides (meters) on the given position, in the Up-East-North (UEN) reference frame.
PoleTides & setXY (const double &x, const double &y)
 Method to set the pole displacement parameters.
double getX (void) const
 Method to get the x pole displacement parameter, in arcseconds.
double getY (void) const
 Method to get the y pole displacement parameter, in arcseconds.
virtual ~PoleTides ()
 Destructor.

Constructor & Destructor Documentation

PoleTides (   )  [inline]
 

Default constructor. Sets zero pole displacement.

Definition at line 83 of file PoleTides.hpp.

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 91 of file PoleTides.hpp.

virtual ~PoleTides (   )  [inline, virtual]
 

Destructor.

Definition at line 162 of file PoleTides.hpp.

Member Function Documentation

Triple getPoleTide (  const CommonTime &  t,
const Position &  p,
const double &  x,
const double &  y
)  throw (InvalidRequest) [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 132 of file PoleTides.hpp.

Triple getPoleTide (  const CommonTime &  t,
const Position &  p
)  throw (InvalidRequest)
 

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 56 of file PoleTides.cpp.

References GPSTK_THROW.

double getX (  void   )  const [inline]
 

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

Definition at line 152 of file PoleTides.hpp.

double getY (  void   )  const [inline]
 

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

Definition at line 157 of file PoleTides.hpp.

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 126 of file PoleTides.cpp.

The documentation for this class was generated from the following files:
Generated on Mon May 20 03:31:50 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1