FieldMap
========

.. currentmodule:: zgoubidoo.fieldmaps.fieldmap

.. autoclass:: FieldMap
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~FieldMap.data
      ~FieldMap.df
      ~FieldMap.field_profile_fit
      ~FieldMap.mesh_sampling_x
      ~FieldMap.mesh_sampling_y
      ~FieldMap.mesh_sampling_z
      ~FieldMap.reference_trajectory

   .. rubric:: Methods Summary

   .. autosummary::

      ~FieldMap.attach_cartesian_trajectory
      ~FieldMap.attach_polar_trajectory
      ~FieldMap.export_for_bdsim
      ~FieldMap.fit_field_profile
      ~FieldMap.load_from_opera
      ~FieldMap.load_from_opera_with_mesh
      ~FieldMap.mesh_sampling_along_axis
      ~FieldMap.plot_field_map
      ~FieldMap.plot_field_profile
      ~FieldMap.rotate
      ~FieldMap.sample
      ~FieldMap.slice
      ~FieldMap.translate

   .. rubric:: Attributes Documentation

   .. autoattribute:: data
   .. autoattribute:: df
   .. autoattribute:: field_profile_fit
   .. autoattribute:: mesh_sampling_x
   .. autoattribute:: mesh_sampling_y
   .. autoattribute:: mesh_sampling_z
   .. autoattribute:: reference_trajectory

   .. rubric:: Methods Documentation

   .. automethod:: attach_cartesian_trajectory
   .. automethod:: attach_polar_trajectory
   .. automethod:: export_for_bdsim
   .. automethod:: fit_field_profile
   .. automethod:: load_from_opera
   .. automethod:: load_from_opera_with_mesh
   .. automethod:: mesh_sampling_along_axis
   .. automethod:: plot_field_map
   .. automethod:: plot_field_profile
   .. automethod:: rotate
   .. automethod:: sample
   .. automethod:: slice
   .. automethod:: translate