spinifex.magnetic.models
========================

.. py:module:: spinifex.magnetic.models

.. autoapi-nested-parse::

   Module for getting the Earth magnetic field



Attributes
----------

.. autoapisummary::

   spinifex.magnetic.models.magnetic_models


Classes
-------

.. autoapisummary::

   spinifex.magnetic.models.MagneticFieldFunction
   spinifex.magnetic.models.MagneticModels
   spinifex.magnetic.models.MagneticProfile


Functions
---------

.. autoapisummary::

   spinifex.magnetic.models.get_ppigrf_magnetic_field
   spinifex.magnetic.models.parse_magnetic_model


Module Contents
---------------

.. py:class:: MagneticFieldFunction

   Bases: :py:obj:`Protocol`


   Magnetic field callable


   .. py:method:: __call__(ipp: spinifex.geometry.get_ipp.IPP) -> MagneticProfile


.. py:class:: MagneticModels

   Supported magnetic field models


   .. py:attribute:: ppigrf
      :type:  MagneticFieldFunction


.. py:class:: MagneticProfile

   Bases: :py:obj:`NamedTuple`


   Data object to hold Magnetic field profile and uncertainties


   .. py:attribute:: magnetic_field
      :type:  astropy.units.Quantity


   .. py:attribute:: magnetic_field_error
      :type:  astropy.units.Quantity


.. py:function:: get_ppigrf_magnetic_field(ipp: spinifex.geometry.get_ipp.IPP) -> MagneticProfile

   Get the magnetic field at a given EarthLocation


.. py:function:: parse_magnetic_model(magnetic_model_name: str) -> MagneticFieldFunction

   parse magnetic model name

   Parameters
   ----------
   magnetic_model_name : str
       name of the magnetic model

   Returns
   -------
   MagneticFieldFunction
       magnetic field function

   Raises
   ------
   TypeError
       if the magnetic model is not known



.. py:data:: magnetic_models