PolarMagnet
===========

.. currentmodule:: zgoubidoo.commands.magnetique

.. autoclass:: PolarMagnet
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~PolarMagnet.PARAMETERS
      ~PolarMagnet.angular_opening
      ~PolarMagnet.center
      ~PolarMagnet.entrance_efb
      ~PolarMagnet.entry_patched
      ~PolarMagnet.entry_wedge_angle
      ~PolarMagnet.exit
      ~PolarMagnet.exit_efb
      ~PolarMagnet.exit_patched
      ~PolarMagnet.exit_wedge_angle
      ~PolarMagnet.length
      ~PolarMagnet.radius
      ~PolarMagnet.reference_angles

   .. rubric:: Methods Summary

   .. autosummary::

      ~PolarMagnet.adjust_tracks_variables
      ~PolarMagnet.drift_length_from_polar
      ~PolarMagnet.efb_angle_from_polar
      ~PolarMagnet.efb_offset_from_polar

   .. rubric:: Attributes Documentation

   .. autoattribute:: PARAMETERS
   .. autoattribute:: angular_opening
   .. autoattribute:: center
   .. autoattribute:: entrance_efb
   .. autoattribute:: entry_patched
   .. autoattribute:: entry_wedge_angle
   .. autoattribute:: exit
   .. autoattribute:: exit_efb
   .. autoattribute:: exit_patched
   .. autoattribute:: exit_wedge_angle
   .. autoattribute:: length
   .. autoattribute:: radius
   .. autoattribute:: reference_angles

   .. rubric:: Methods Documentation

   .. automethod:: adjust_tracks_variables
   .. automethod:: drift_length_from_polar
   .. automethod:: efb_angle_from_polar
   .. automethod:: efb_offset_from_polar