tobac.analysis.cell_analysis.mask_cell_surface

tobac.analysis.cell_analysis.mask_cell_surface(mask, cell, track, masked=False, z_coord='model_level_number')

Create surface projection of 3d-mask for individual cell by collapsing one coordinate.

Parameters:

• mask (iris.cube.Cube) – Cube containing mask (int id for tacked volumes, 0 everywhere else).

• cell (int) – Integer id of cell to create masked cube for.

• track (pandas.DataFrame) – Output of the linking.

• masked (bool, optional) – Bool determining whether to mask the mask for the cell where it is 0. Default is False.

• z_coord (str, optional) – Name of the coordinate to collapse. Default is ‘model_level_number’.

Returns:

mask_i_surface – Collapsed Masked cube for the cell with the maximum value along the collapsed coordinate.

Return type:

iris.cube.Cube