xarray.Dataset.hyoga.assign_icemask

Dataset.hyoga.assign_icemask(datasource, name='icemask')

Assign an ice mask corresponding to glacierized area.

Hyoga looks for this variable in most plot methods, and defaults to considering any grid cell with non-zero ice thickness as glacierized.

Parameters:

• datasource (DataArray, Dataset, str, Path, file-like or DataStore) – Data array, or a dataset or path to a file containing the ice mask (standard name “land_ice_area_fraction”).

• name (string, optional) – Default name for the new ice mask variable. Not used if standard name “land_ice_area_fraction” is already present in the dataset.

Returns:

dataset (Dataset) – The dataset with added ice mask variable, with standard name “land_ice_area_fraction” (replacing existing variables).