geodata.mask.load_mask

geodata.mask.load_mask#

geodata.mask.load_mask(name: str, mask_dir: str | pathlib.Path | None = MASK_DIR)#

Load a previously saved mask object

Parameters:
  • name (str) – name for the mask

  • mask_dir (str) – directory to look for previously saved mask file and where the mask object will be updated. By default, it should be the mask path in config.py

Returns:

the loaded mask object

Return type:

Mask