Mask
====

.. currentmodule:: lib.align.aligned_mask

.. autoclass:: Mask
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Mask.affine_matrix
      ~Mask.interpolator
      ~Mask.mask
      ~Mask.original_roi
      ~Mask.stored_mask

   .. rubric:: Methods Summary

   .. autosummary::

      ~Mask.add
      ~Mask.from_dict
      ~Mask.get_full_frame_mask
      ~Mask.replace_mask
      ~Mask.set_blur_and_threshold
      ~Mask.set_dilation
      ~Mask.set_sub_crop
      ~Mask.to_dict
      ~Mask.to_png_meta

   .. rubric:: Attributes Documentation

   .. autoattribute:: affine_matrix
   .. autoattribute:: interpolator
   .. autoattribute:: mask
   .. autoattribute:: original_roi
   .. autoattribute:: stored_mask

   .. rubric:: Methods Documentation

   .. automethod:: add
   .. automethod:: from_dict
   .. automethod:: get_full_frame_mask
   .. automethod:: replace_mask
   .. automethod:: set_blur_and_threshold
   .. automethod:: set_dilation
   .. automethod:: set_sub_crop
   .. automethod:: to_dict
   .. automethod:: to_png_meta