spinifex.ionospheric
====================

.. py:module:: spinifex.ionospheric

.. autoapi-nested-parse::

   Module for getting ionospheric ionospheric_models



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/spinifex/ionospheric/index_tools/index
   /autoapi/spinifex/ionospheric/ionex_download/index
   /autoapi/spinifex/ionospheric/ionex_manipulation/index
   /autoapi/spinifex/ionospheric/ionex_parser/index
   /autoapi/spinifex/ionospheric/iri_density/index
   /autoapi/spinifex/ionospheric/iriup_parser/index
   /autoapi/spinifex/ionospheric/models/index
   /autoapi/spinifex/ionospheric/tec_data/index
   /autoapi/spinifex/ionospheric/tomion_parser/index


Attributes
----------

.. autoapisummary::

   spinifex.ionospheric.ionospheric_models


Classes
-------

.. autoapisummary::

   spinifex.ionospheric.ModelDensityFunction


Functions
---------

.. autoapisummary::

   spinifex.ionospheric.get_density_ionex_iri
   spinifex.ionospheric.get_density_ionex_single_layer


Package Contents
----------------

.. py:class:: ModelDensityFunction

   Bases: :py:obj:`Protocol`, :py:obj:`Generic`\ [\ :py:obj:`O_contra`\ ]


   Model density callable


   .. py:method:: __call__(ipp: spinifex.geometry.get_ipp.IPP, options: O_contra | None = None) -> spinifex.ionospheric.tec_data.ElectronDensity


.. py:function:: get_density_ionex_iri(ipp: spinifex.geometry.get_ipp.IPP, options: spinifex.ionospheric.tec_data.IonexOptions | None = None) -> spinifex.ionospheric.tec_data.ElectronDensity

   gets the ionex files and interpolate values for a single altitude, then multiply with a
   normalised density profile from iri

   Parameters
   ----------
   ipp : IPP
       ionospheric piercepoints
   height : u.Quantity, optional
       altitude of the thin screen, by default 350*u.km
   ionex_options: IonexOptions | None, optional
       options for the ionospheric model, by default None

   Returns
   -------
   NDArray
       interpolated vTEC values at ipp


.. py:function:: get_density_ionex_single_layer(ipp: spinifex.geometry.get_ipp.IPP, options: spinifex.ionospheric.tec_data.IonexOptions | None = None) -> spinifex.ionospheric.tec_data.ElectronDensity

   gets the ionex files and interpolate values for a single altitude, thin screen assumption

   Parameters
   ----------
   ipp : IPP
       ionospheric piercepoints
   ionex_options: IonexOptions | None, optional
       options for the ionospheric model, by default None

   Returns
   -------
   NDArray
       interpolated vTEC values at ipp, zeros everywhere apart from the altitude
       closest to the specified height


.. py:data:: ionospheric_models