Sidereon.Terrain.MmapTerrain.OrthometricHeightM (Sidereon v0.28.0)

Orthometric terrain height H in metres above the EGM96 mean sea level geoid.

Summary

Types

t()

Orthometric height H in metres.

Functions

metres(orthometric_height_m)

Return the orthometric height H in metres.

new(value_m)

Build an orthometric height H in metres.

to_ellipsoidal_height_deg(height, latitude_deg, longitude_deg, model \\ TerrainGeoidModel.egm96_one_degree())

Convert this orthometric height to WGS84 ellipsoidal height with degree coordinates.

to_ellipsoidal_height_rad(height, latitude_rad, longitude_rad, model \\ TerrainGeoidModel.egm96_one_degree())

Convert this orthometric height to WGS84 ellipsoidal height with radian coordinates.

Types

t()

@type t() :: %Sidereon.Terrain.MmapTerrain.OrthometricHeightM{value_m: float()}

Orthometric height H in metres.

Functions

metres(orthometric_height_m)

@spec metres(t()) :: float()

Return the orthometric height H in metres.

new(value_m)

@spec new(number()) :: t()

Build an orthometric height H in metres.

to_ellipsoidal_height_deg(height, latitude_deg, longitude_deg, model \\ TerrainGeoidModel.egm96_one_degree())

@spec to_ellipsoidal_height_deg(
  t(),
  number(),
  number(),
  Sidereon.Terrain.MmapTerrain.TerrainGeoidModel.t() | :egm96_one_degree
) ::
  {:ok, Sidereon.Terrain.MmapTerrain.EllipsoidalHeightM.t()}
  | {:error, Sidereon.Terrain.MmapTerrain.TerrainDatumError.t() | term()}

Convert this orthometric height to WGS84 ellipsoidal height with degree coordinates.

Coordinates are geoid order (latitude_deg, longitude_deg). The default geoid model is the embedded EGM96 1-degree grid. To use the EGM96 15-minute grid, pass TerrainGeoidModel.egm96_fifteen_minute/1 with a loaded Egm96FifteenMinuteGeoid.

to_ellipsoidal_height_rad(height, latitude_rad, longitude_rad, model \\ TerrainGeoidModel.egm96_one_degree())

@spec to_ellipsoidal_height_rad(
  t(),
  number(),
  number(),
  Sidereon.Terrain.MmapTerrain.TerrainGeoidModel.t() | :egm96_one_degree
) ::
  {:ok, Sidereon.Terrain.MmapTerrain.EllipsoidalHeightM.t()}
  | {:error, Sidereon.Terrain.MmapTerrain.TerrainDatumError.t() | term()}

Convert this orthometric height to WGS84 ellipsoidal height with radian coordinates.

Coordinates are geoid order (latitude_rad, longitude_rad). The default geoid model is the embedded EGM96 1-degree grid.