polaris.ocean.overturning.bin_line_transport

polaris.ocean.overturning.bin_line_transport(transport: DataArray, edge_thickness: DataArray, edge_tracer: DataArray, bins: ndarray, vert_dim: str = 'nVertLevels') → Dataset

Sort the transport and thickness on each edge of a line into tracer classes, for overturning in tracer (e.g. density) coordinates

Parameters:

• transport (xarray.DataArray) – Transport from compute_line_transport(), with dimensions nLineEdges and vert_dim

• edge_thickness (xarray.DataArray) – The layer thickness on each edge of the line, e.g. from interp_cell_to_line_edges(), with the same dimensions as transport

• edge_tracer (xarray.DataArray) – The tracer on each edge of the line, with the same dimensions as transport

• bins (numpy.ndarray) – Monotonically increasing bin boundaries; values outside them fall into no bin

• vert_dim (str, optional) – The vertical dimension

Returns:

ds_binned (xarray.Dataset) – A dataset with vert_dim replaced by nBins, containing transport (m3 s-1) and thickness (m) summed over the layers in each class, and the coordinates binLower and binUpper