polaris.ocean.vertical.elevation.VerticalReduction

class polaris.ocean.vertical.elevation.VerticalReduction(kind: str, label: str, level: int | None = None, elevation: float | None = None, z_top: float | None = None, z_bot: float | None = None)[source]

One way of reducing a field with a vertical dimension to a horizontal map

Variables:

  • kind (str) – 'top', 'bottom', 'index', 'elevation' or 'range'

  • label (str) – The label that identifies the reduction in a file name and a plot title, e.g. 'top', 'k10', '-100m' or 'top_to_-700m'

  • level (int or None) – The zero-based vertical index, for 'index'

  • elevation (float or None) – The elevation in m, positive up, for 'elevation'

  • z_top (float or None) – The upper bound of the range in m, positive up, for 'range'. It is inf where the bound is the free surface of each column.

  • z_bot (float or None) – The lower bound of the range in m, positive up, for 'range'. It is -inf where the bound is the seafloor of each column.

__init__()

Methods

__init__()

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

Attributes

elevation

Alias for field number 3

kind

Alias for field number 0

label

Alias for field number 1

level

Alias for field number 2

z_bot

Alias for field number 5

z_top

Alias for field number 4