MotionBuilder
=============

.. currentmodule:: bapsf_motion.motion_builder.core

.. autoclass:: MotionBuilder
   :show-inheritance:

   
     
   

   
   

   .. rubric:: Attributes Summary

   .. autosummary::
   
      ~MotionBuilder.base_name
      ~MotionBuilder.base_names
      ~MotionBuilder.config
      ~MotionBuilder.exclusions
      ~MotionBuilder.item
      ~MotionBuilder.layer_to_motionlist_scheme
      ~MotionBuilder.layers
      ~MotionBuilder.mask
      ~MotionBuilder.mask_name
      ~MotionBuilder.mask_resolution
      ~MotionBuilder.motion_list
      ~MotionBuilder.mspace_coords
      ~MotionBuilder.mspace_dims
      ~MotionBuilder.mspace_ndims
      ~MotionBuilder.name
      ~MotionBuilder.name_pattern

   
   

   
   

   .. rubric:: Methods Summary

   .. autosummary::
   
      ~MotionBuilder.add_exclusion
      ~MotionBuilder.add_layer
      ~MotionBuilder.clear_motion_list
      ~MotionBuilder.drop_vars
      ~MotionBuilder.flatten_points
      ~MotionBuilder.generate
      ~MotionBuilder.generate_excluded_mask
      ~MotionBuilder.get_insertion_point
      ~MotionBuilder.is_excluded
      ~MotionBuilder.plot_mask
      ~MotionBuilder.rebuild_mask
      ~MotionBuilder.remove_exclusion
      ~MotionBuilder.remove_layer

   
   

   
   

   .. rubric:: Attributes Documentation

   
   .. autoattribute:: base_name
   .. autoattribute:: base_names
   .. autoattribute:: config
   .. autoattribute:: exclusions
   .. autoattribute:: item
   .. autoattribute:: layer_to_motionlist_scheme
   .. autoattribute:: layers
   .. autoattribute:: mask
   .. autoattribute:: mask_name
   .. autoattribute:: mask_resolution
   .. autoattribute:: motion_list
   .. autoattribute:: mspace_coords
   .. autoattribute:: mspace_dims
   .. autoattribute:: mspace_ndims
   .. autoattribute:: name
   .. autoattribute:: name_pattern

   
   

   
   

   .. rubric:: Methods Documentation

   
   .. automethod:: add_exclusion
   .. automethod:: add_layer
   .. automethod:: clear_motion_list
   .. automethod:: drop_vars
   .. automethod:: flatten_points
   .. automethod:: generate
   .. automethod:: generate_excluded_mask
   .. automethod:: get_insertion_point
   .. automethod:: is_excluded
   .. automethod:: plot_mask
   .. automethod:: rebuild_mask
   .. automethod:: remove_exclusion
   .. automethod:: remove_layer