convert_mask_3d_to_2d

echoregions.convert_mask_3d_to_2d(mask_3d_ds: Dataset) → Optional[Dataset]

Convert 3D one-hot encoded mask data into its 2D multi-labeled form.

Parameters

mask_3d_dsDataset

A dataset with the following:

A DataArray 3D mask where each layer of the mask will contain a 1s/0s mask for each unique label in the 2D mask. The layers will be labeled via region_id values extracted from 2d values. DataArray with mask labels corresponding to region_id values.

Returns

mask_2d_dsDataset

A dataset with the following:

DataArray with the data_var masked by a specified region. Individual data points will be in the form of integers, demarking region_id of masked regions, and nan values, demarking non-masked areas. DataArray with mask labels corresponding to region_id values.