AtmField
########

.. currentmodule:: pyarts3.arts

.. autoclass:: AtmField

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts3.arts.AtmField.as_gridded`
      - Convert all fields of the input atmospheric field to gridded fields.
    * - Method
      - :func:`~pyarts3.arts.AtmField.keys`
      - Get a list of the keys from an atmospheric field.
    * - Method
      - :func:`~pyarts3.arts.AtmField.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts3.arts.AtmField.savexml`
      - Saves variable to file
    * - Method
      - :func:`~pyarts3.arts.AtmField.species_keys`
      - Species keys
    * - Method
      - :func:`~pyarts3.arts.AtmField.to_dict`
      - Convert an atmospheric field to a dictionary.
    * - Method
      - :func:`~pyarts3.arts.AtmField.to_xarray`
      - Convert the atmospheric field to an xarray dataset.
    * - Method
      - :func:`~pyarts3.arts.AtmField.update`
      - Update the atmospheric field with dictionary values.
    * - Static Method
      - :func:`~pyarts3.arts.AtmField.from_dict`
      - Create an atmospheric field from a dictionary.
    * - Static Method
      - :func:`~pyarts3.arts.AtmField.fromxml`
      - Create variable from file
    * - Attribute
      - :attr:`~pyarts3.arts.AtmField.isots`
      - Isotopologue ratio data
    * - Attribute
      - :attr:`~pyarts3.arts.AtmField.nlte`
      - NLTE data
    * - Attribute
      - :attr:`~pyarts3.arts.AtmField.other`
      - Basic atmospheric data
    * - Attribute
      - :attr:`~pyarts3.arts.AtmField.specs`
      - Species data
    * - Attribute
      - :attr:`~pyarts3.arts.AtmField.ssprops`
      - Scattering species properties data
    * - Attribute
      - :attr:`~pyarts3.arts.AtmField.top_of_atmosphere`
      - Top of the atmosphere [m]
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__call__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__eq__`
      - Return self==value.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__ge__`
      - Return self>=value.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__getitem__`
      - __getitem__(self, arg: pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty, /) -> pyarts3.arts.AtmData
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__getstate__`
      - __getstate__(self) -> tuple[list[pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty], pyarts3.arts.ArrayOfAtmData, float]
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__gt__`
      - Return self>value.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__init__`
      - __init__(self, toa: float = 100000.0, iso: pyarts3.arts.IsoRatioOption = "Builtin") -> None
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__le__`
      - Return self<=value.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__lt__`
      - Return self<value.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__ne__`
      - Return self!=value.
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__setitem__`
      - __setitem__(self, arg0: pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty, arg1: pyarts3.arts.AtmData, /) -> None
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__setstate__`
      - __setstate__(self, arg: tuple[collections.abc.Sequence[pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty], pyarts3.arts.ArrayOfAtmData, float], /) -> None
    * - Operator
      - :func:`~pyarts3.arts.AtmField.__str__`
      - __str__(self) -> str

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: AtmField.as_gridded
  .. automethod:: AtmField.keys
  .. automethod:: AtmField.readxml
  .. automethod:: AtmField.savexml
  .. automethod:: AtmField.species_keys
  .. automethod:: AtmField.to_dict
  .. automethod:: AtmField.to_xarray
  .. automethod:: AtmField.update

  .. rubric:: Static Methods

  .. automethod:: AtmField.from_dict
  .. automethod:: AtmField.fromxml

  .. rubric:: Attributes

  .. attribute:: AtmField.isots
     :type: dict[~pyarts3.arts.SpeciesIsotope, ~pyarts3.arts.AtmData]
     
     Isotopologue ratio data
     
     .. :class:`dict[~pyarts3.arts.SpeciesIsotope, ~pyarts3.arts.AtmData]`

  .. attribute:: AtmField.nlte
     :type: dict[~pyarts3.arts.QuantumIdentifier, ~pyarts3.arts.AtmData]
     
     NLTE data
     
     .. :class:`dict[~pyarts3.arts.QuantumIdentifier, ~pyarts3.arts.AtmData]`

  .. attribute:: AtmField.other
     :type: dict[~pyarts3.arts.AtmKey, ~pyarts3.arts.AtmData]
     
     Basic atmospheric data
     
     .. :class:`dict[~pyarts3.arts.AtmKey, ~pyarts3.arts.AtmData]`

  .. attribute:: AtmField.specs
     :type: dict[~pyarts3.arts.SpeciesEnum, ~pyarts3.arts.AtmData]
     
     Species data
     
     .. :class:`dict[~pyarts3.arts.SpeciesEnum, ~pyarts3.arts.AtmData]`

  .. attribute:: AtmField.ssprops
     :type: dict[~pyarts3.arts.ScatteringSpeciesProperty, ~pyarts3.arts.AtmData]
     
     Scattering species properties data
     
     .. :class:`dict[~pyarts3.arts.ScatteringSpeciesProperty, ~pyarts3.arts.AtmData]`

  .. attribute:: AtmField.top_of_atmosphere
     :type: ~pyarts3.arts.Numeric
     
     Top of the atmosphere [m]
     
     .. :class:`~pyarts3.arts.Numeric`


  .. rubric:: Operators

  .. automethod:: AtmField.__call__
  .. automethod:: AtmField.__eq__
  .. automethod:: AtmField.__format__
  .. automethod:: AtmField.__ge__
  .. automethod:: AtmField.__getitem__
  .. automethod:: AtmField.__getstate__
  .. automethod:: AtmField.__gt__
  .. automethod:: AtmField.__hash__
  .. automethod:: AtmField.__init__
  .. automethod:: AtmField.__le__
  .. automethod:: AtmField.__lt__
  .. automethod:: AtmField.__ne__
  .. automethod:: AtmField.__repr__
  .. automethod:: AtmField.__setitem__
  .. automethod:: AtmField.__setstate__
  .. automethod:: AtmField.__str__