earthkit.meteo.vertical.geopotential_height_from_geopotential

earthkit.meteo.vertical.geopotential_height_from_geopotential(z: ArrayLike) → ArrayLike

earthkit.meteo.vertical.geopotential_height_from_geopotential(z: xarray.DataArray) → xarray.DataArray

earthkit.meteo.vertical.geopotential_height_from_geopotential(z: earthkit.data.FieldList) → earthkit.data.FieldList

Compute geopotential height from geopotential.

Parameters:

z (array-like | xarray.DataArray | FieldList) – Geopotential (m2/s2).

Returns:

Geopotential height (m).

Return type:

array-like | xarray.DataArray | FieldList

The computation is based on the following definition:

\[gh = \frac{z}{g}\]

where \(g\) is the gravitational acceleration on the surface of the Earth (see earthkit.meteo.constants.g).

Implementations

geopotential_height_from_geopotential() calls one of the following implementations depending on the type of the input arguments:

• earthkit.meteo.vertical.array.geopotential_height_from_geopotential() for array-like

• earthkit.meteo.vertical.xarray.geopotential_height_from_geopotential() for xarray.DataArray

• earthkit.meteo.vertical.fieldlist.geopotential_height_from_geopotential() for FieldList

The function returns an object of the same type as the input arguments.