Function Name: Get WGS84 Geoidal Separation

Definition

Returns the height of the WGS84 geoid above or below the WGS84 ellipsoid, at the specified geodetic coordinates, using a grid of height adjustments from the EGM96 gravity model.

This grid of height adjustments must be specified by the environmental variable $SE_WW15MGH_GRD_PATH at run time.

Returns

SE_COORD_SUCCESS - and sets *GeoidalSeparation_ptr to the height of the WGS84 geoid above or below the WGS84 ellipsoid, at the specified coordinates.

SE_COORD_INVALID_SOURCE_COORD - and *GeoidalSeparation_ptr is left unaltered, if WGS84GeodeticLocation_ptr is NULL.

SE_COORD_INVALID_DEST_COORD - and *GeoidalSeparation_ptr is left unaltered, if GeoidalSeparation_ptr is NULL.

SE_COORD_MISSING_WGS84_GEOID_SEPARATION_FILE - and *GeoidalSeparation_ptr is left unaltered, if the environmental variable $SE_WW15MGH_GRD_PATH has not been set, or if the file at that location cannot be located or successfully opened.

SE_COORD_INVALID_WGS84_GEOID_SEPARATION_FILE - and *GeoidalSeparation_ptr is left unaltered, if the geoidal separation file is not in a valid format.

SE_COORD_FAILURE - and *GeoidalSeparation_ptr is left unaltered, if the internal geoidal separation table cannot be allocated.

Prototype


extern SE_COORD_STATUS_CODE_ENUM
SRM_GetWGS84GeoidalSeparation
(
constSRM_GD_2D_COORD *WGS84GeodeticLocation_ptr, (notes)
SE_FLOAT64 *GeoidalSeparation_ptr (notes)
);

Parameters Notes

WGS84GeodeticLocation_ptr

 pointer to a Geodetic location on the WGS84 geoid, for which we want
 the geoidal separation from the WGS84 ellipsoid.

GeoidalSeparation_ptr

 pointer to an SE_FLOAT64 variable in the user's memory space, into
 which the geoidal separation at the specified location will be copied.

Prev: Get Corresponding 3D SRF. Next: HLS to RGB. Up:Index.