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

.. py:module:: spinifex.ionospheric.tec_data

.. autoapi-nested-parse::

   data objects and options for ionospheric models



Attributes
----------

.. autoapisummary::

   spinifex.ionospheric.tec_data.CENTER_NAMES
   spinifex.ionospheric.tec_data.DEFAULT_TIME_RESOLUTIONS
   spinifex.ionospheric.tec_data.NAME_SWITCH_WEEK
   spinifex.ionospheric.tec_data.SOLUTION


Classes
-------

.. autoapisummary::

   spinifex.ionospheric.tec_data.ElectronDensity
   spinifex.ionospheric.tec_data.IonexOptions
   spinifex.ionospheric.tec_data.Servers
   spinifex.ionospheric.tec_data.TomionOptions


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

.. py:class:: ElectronDensity

   Bases: :py:obj:`NamedTuple`


   object containing interpolated electron density values and their estimated uncertainty


   .. py:attribute:: electron_density
      :type:  numpy.typing.NDArray[numpy.float64]

      electron density in TECU



   .. py:attribute:: electron_density_error
      :type:  numpy.typing.NDArray[numpy.float64]

      uncertainty in TECU



.. py:class:: IonexOptions(/, **data: Any)

   Bases: :py:obj:`spinifex.options.Options`


   Options for ionex model


   .. py:attribute:: correct_uqrg_rms
      :type:  bool
      :value: None



   .. py:attribute:: height
      :type:  astropy.units.Quantity
      :value: None



   .. py:attribute:: output_directory
      :type:  pathlib.Path | None
      :value: None



   .. py:attribute:: prefix
      :type:  str
      :value: None



   .. py:attribute:: remove_midnight_jumps
      :type:  bool
      :value: None



   .. py:attribute:: server
      :type:  Servers
      :value: None



   .. py:attribute:: solution
      :type:  SOLUTION
      :value: None



   .. py:attribute:: time_resolution
      :type:  astropy.units.Quantity | None
      :value: None



   .. py:attribute:: url_stem
      :type:  str | None
      :value: None



.. py:class:: Servers

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to 'utf-8'.
   errors defaults to 'strict'.


   .. py:method:: get_url(server: Servers) -> str
      :classmethod:



   .. py:attribute:: CDDIS
      :value: ('cddis', 'https://cddis.nasa.gov/archive/gnss/products/ionex')



   .. py:attribute:: CHAPMAN
      :value: ('chapman', 'http://chapman.upc.es/tomion/rapid')



   .. py:attribute:: IGSIONO
      :value: ('igsiono', 'ftp://igs-final.man.olsztyn.pl')



   .. py:property:: url
      :type: str



.. py:class:: TomionOptions(/, **data: Any)

   Bases: :py:obj:`spinifex.options.Options`


   Options for tomion model


   .. py:attribute:: output_directory
      :type:  pathlib.Path | None
      :value: None



.. py:data:: CENTER_NAMES

.. py:data:: DEFAULT_TIME_RESOLUTIONS
   :type:  dict[str, astropy.units.Quantity]

.. py:data:: NAME_SWITCH_WEEK
   :value: 2238


.. py:data:: SOLUTION