geodata.cutout.Cutout.add_mask
==============================

.. py:method:: geodata.cutout.Cutout.add_mask(name: str, merged_mask: bool = True, shape_mask: bool = True)

   Add mask attribute to the cutout, from a previously saved mask objects.
   The masks will be coarsened to the same dimension with the cutout metadata in xarray.

   :param name: The name of the previously saved mask. The mask object should be saved in
                mask_dir in config.py.
   :type name: str
   :param merged_mask: If true, the program will try to include the merged_mask from the mask object.
                       Defaults to True.
   :type merged_mask: bool
   :param shape_mask: If true, the program will try to include the extracted dictionary of
                      shape_mask from the mask object. Defaults to True.
   :type shape_mask: bool