CircularExclusion
=================

.. currentmodule:: bapsf_motion.motion_builder.exclusions.circular

.. autoclass:: CircularExclusion
   :show-inheritance:

   
     
   

   
   

   .. rubric:: Attributes Summary

   .. autosummary::
   
      ~CircularExclusion.base_name
      ~CircularExclusion.center
      ~CircularExclusion.config
      ~CircularExclusion.dimensionality
      ~CircularExclusion.exclude_region
      ~CircularExclusion.exclusion
      ~CircularExclusion.exclusion_type
      ~CircularExclusion.inputs
      ~CircularExclusion.item
      ~CircularExclusion.mask
      ~CircularExclusion.mask_name
      ~CircularExclusion.mask_resolution
      ~CircularExclusion.mspace_coords
      ~CircularExclusion.mspace_dims
      ~CircularExclusion.mspace_ndims
      ~CircularExclusion.name
      ~CircularExclusion.name_pattern
      ~CircularExclusion.radius
      ~CircularExclusion.composed_exclusions

   
   

   
   

   .. rubric:: Methods Summary

   .. autosummary::
   
      ~CircularExclusion.drop_vars
      ~CircularExclusion.is_excluded
      ~CircularExclusion.regenerate_exclusion
      ~CircularExclusion.update_global_mask

   
   

   
   

   .. rubric:: Attributes Documentation

   
   .. autoattribute:: base_name
   .. autoattribute:: center
   .. autoattribute:: config
   .. autoattribute:: dimensionality
   .. autoattribute:: exclude_region
   .. autoattribute:: exclusion
   .. autoattribute:: exclusion_type
   .. autoattribute:: inputs
   .. autoattribute:: item
   .. autoattribute:: mask
   .. autoattribute:: mask_name
   .. autoattribute:: mask_resolution
   .. autoattribute:: mspace_coords
   .. autoattribute:: mspace_dims
   .. autoattribute:: mspace_ndims
   .. autoattribute:: name
   .. autoattribute:: name_pattern
   .. autoattribute:: radius
   .. autoattribute:: composed_exclusions

   
   

   
   

   .. rubric:: Methods Documentation

   
   .. automethod:: drop_vars
   .. automethod:: is_excluded
   .. automethod:: regenerate_exclusion
   .. automethod:: update_global_mask