arlmet.VerticalAxis.to_height_agl#

abstractmethod VerticalAxis.to_height_agl(*, surface_pressure=None, temperature=None, pressure=None, hgts=None, terrain=None)[source]#

Compute height above ground level [m] at each level.

Each axis uses only the inputs its coordinate system needs (matching HYSPLIT’s prfcom) and ignores the rest.

Parameters:

  • surface_pressure (ArrayLike | None) – Surface pressure [hPa] (PRSS). Required for sigma, hybrid and WRF.

  • temperature (ArrayLike | None) – Temperature [K] at each level (TEMP), levels on the last axis; the virtual temperature gives the heights HYSPLIT finds. Required for sigma, hybrid and WRF.

  • pressure (ArrayLike | None) – Pressure [hPa] at each level (PRES), the same shape as temperature. Required for WRF; sigma uses it in place of the nominal sigma pressure when given, as HYSPLIT’s prfsig does; hybrid ignores it, as HYSPLIT’s prfecm does.

  • hgts (ArrayLike | None) – Geopotential height [m MSL] at each level (HGTS). Required for pressure axes.

  • terrain (ArrayLike | None) – Terrain height [m] (SHGT), broadcastable to hgts. Required for pressure axes.

Returns:

Heights AGL [m].

Return type:

NDArray[double]

Raises:

ValueError – If an input this axis needs is missing.