calculate_geoid_undulation

  • Wrapper function for computing geoid undulations from a gravity model

Calling Sequence

from geoid_toolkit.calculate_geoid_undulation import calculate_geoid_undulation
N = calculate_geoid_undulation(lon, lat, gravity_model_file, ELLIPSOID='WGS84')

Source code

geoid_toolkit.calculate_geoid_undulation(lon, lat, gravity_model_file, **kwargs)[source]

Wrapper function for computing geoid undulations from a gravity model

Parameters:
lon: float

longitudinal points to calculate geoid height

lat: float

latitudinal points to calculate geoid height

gravity_model_file: str

full path to static gravity model file

LMAX: int or NoneType, default None

maximum spherical harmonic degree

ELLIPSOID: str, default ‘WGS84’

Reference ellipsoid name

  • 'CLK66': Clarke 1866

  • 'GRS67': Geodetic Reference System 1967

  • 'GRS80': Geodetic Reference System 1980

  • 'HGH80': Hughes 1980 Ellipsoid

  • 'WGS72': World Geodetic System 1972

  • 'WGS84': World Geodetic System 1984

  • 'ATS77': Quasi-earth centred ellipsoid for ATS77

  • 'NAD27': North American Datum 1927

  • 'NAD83': North American Datum 1983

  • 'INTER': International

  • 'KRASS': Krassovsky (USSR)

  • 'MAIRY': Modified Airy (Ireland 1965/1975)

  • 'TOPEX': TOPEX/POSEIDON ellipsoid

  • 'EGM96': EGM 1996 gravity model

TIDE: str, default ‘tide_free’

Permanent tide system of output geoid

  • 'tide_free': no permanent direct and indirect tidal potentials

  • 'mean_tide': permanent tidal potentials (direct and indirect)

  • 'zero_tide': permanent direct tidal potential removed

GAUSS: int, default 0

Gaussian Smoothing Radius in km

EPS: float, default 1e-8

level of precision for calculating geoid height

ZIP: bool, default False

Gravity field file is compressed in an archive file

Returns:
N: float

geoidal undulation for a given ellipsoid in meters