spinifex.get_dtec
=================

.. py:module:: spinifex.get_dtec

.. autoapi-nested-parse::

   Module to calculate electron densities



Classes
-------

.. autoapisummary::

   spinifex.get_dtec.DTEC


Functions
---------

.. autoapisummary::

   spinifex.get_dtec._get_dtec
   spinifex.get_dtec._get_dtec_from_altaz
   spinifex.get_dtec._get_dtec_from_skycoord
   spinifex.get_dtec.get_dtec_from_altaz
   spinifex.get_dtec.get_dtec_from_skycoord


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

.. py:class:: DTEC

   Bases: :py:obj:`NamedTuple`


   object with all electron densities


   .. py:attribute:: airmass
      :type:  numpy.typing.NDArray[numpy.floating[Any]]

      conversion from vertical to slant TEC



   .. py:attribute:: electron_density
      :type:  numpy.typing.NDArray[numpy.floating[Any]]

      electron density (TECU)



   .. py:attribute:: electron_density_error
      :type:  numpy.typing.NDArray[numpy.floating[Any]]

      electron density uncertainty (TECU)



   .. py:attribute:: height
      :type:  numpy.typing.NDArray[numpy.floating[Any]]

      array of altitudes (km)



   .. py:attribute:: loc
      :type:  astropy.coordinates.EarthLocation

      observer location



   .. py:attribute:: times
      :type:  astropy.time.Time

      time axis



.. py:function:: _get_dtec(ipp: spinifex.geometry.IPP, iono_model: spinifex.ionospheric.ModelDensityFunction[spinifex.ionospheric.models.O], iono_options: spinifex.ionospheric.models.O | None = None) -> DTEC

   Get the electron densities for a given set of ionospheric piercepoints

   Parameters
   ----------
   ipp : IPP
       ionospheric piercepoints
   iono_model : ModelDensityFunction, optional
       ionospheric model, by default ionospheric_models.ionex
   iono_options : OptionType, optional
       options for the ionospheric model, by default None

   Returns
   -------
   DTEC
       electron densities object


.. py:function:: _get_dtec_from_altaz(loc: astropy.coordinates.EarthLocation, altaz: astropy.coordinates.AltAz, iono_model: spinifex.ionospheric.ModelDensityFunction[spinifex.ionospheric.models.O], height_array: astropy.units.Quantity = DEFAULT_IONO_HEIGHT, iono_options: spinifex.ionospheric.models.O | None = None) -> DTEC

   get electron densities for user defined altaz coordinates

   Parameters
   ----------
   loc : EarthLocation
       observer location
   altaz : AltAz
       altaz coordinates
   height_array : u.Quantity, optional
       altitudes, by default default_height
   iono_model : ModelDensityFunction, optional
       ionospheric model, by default ionospheric_models.ionex
   iono_options : dict
       keyword arguments for the ionospheric model


   Returns
   -------
   DTEC
       electron density object


.. py:function:: _get_dtec_from_skycoord(loc: astropy.coordinates.EarthLocation, times: astropy.time.Time, source: astropy.coordinates.SkyCoord, iono_model: spinifex.ionospheric.ModelDensityFunction[spinifex.ionospheric.models.O], height_array: astropy.units.Quantity = DEFAULT_IONO_HEIGHT, iono_options: spinifex.ionospheric.models.O | None = None) -> DTEC

   get electron densities for user defined times and source coordinate

   Parameters
   ----------
   loc : EarthLocation
       observer location
   times : Time
       times
   source : SkyCoord
       coordinates of the source
   height_array : NDArray, optional
       altitudes, by default default_height
   iono_model : ModelDensityFunction, optional
       ionospheric model, by default ionospheric_models.ionex
   iono_kwargs : dict
       keyword arguments for the ionospheric model


   Returns
   -------
   DTEC
       relectron density object


.. py:function:: get_dtec_from_altaz(loc: astropy.coordinates.EarthLocation, altaz: astropy.coordinates.AltAz, iono_model_name: str = 'ionex', **iono_kwargs: Any) -> DTEC

   get rotation measures for user defined altaz coordinates

   Parameters
   ----------
   loc : EarthLocation
       observer location
   altaz : AltAz
       altaz coordinates
   iono_model_name : str, optional
       ionospheric model name, by default "ionex". Must be a supported ionospheric model.
   iono_options : dict
       keyword arguments for the ionospheric model


   Returns
   -------
   DTEC
       electron density object


.. py:function:: get_dtec_from_skycoord(loc: astropy.coordinates.EarthLocation, times: astropy.time.Time, source: astropy.coordinates.SkyCoord, iono_model_name: str = 'ionex', **iono_kwargs: Any) -> DTEC

   get electron densities for user defined times and source coordinate

   Parameters
   ----------
   loc : EarthLocation
       observer location
   times : Time
       times
   source : SkyCoord
       coordinates of the source
   iono_model_name : str, optional
       ionospheric model name, by default "ionex". Must be a supported ionospheric model.
   iono_kwargs : dict
       keyword arguments for the ionospheric model


   Returns
   -------
   DTEC
       relectron density object