eradiate.radprops.ZGrid

class eradiate.radprops.ZGrid(levels)[source]

Bases: object

A container for a regular altitude grid.

Parameters:

levels (quantity or array-like) – Grid node altitudes.

Unit-enabled field (default: ucc['length']).

Fields:

levels (pint.Quantity) – Grid node altitudes.

Notes

  • Instances are immutable.

  • Instances are hashable by ID. This is required to allow for using them as an argument of an LRU-cached function.

  • This class is used as the argument of the eval() family of methods.

property layer_height
Returns:

quantity – Layer height.

property layers
Returns:

quantity – Vector of altitudes of layer centres.

property n_layers
Returns:

int – Number of layers.

property n_levels
Returns:

int – Number of levels.

property total_height
Returns:

quantity – Total height covered by the altitude grid.