GriddedField2
#############

.. currentmodule:: pyarts.arts

.. autoclass:: GriddedField2

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts.arts.GriddedField2.conj`
      - Wrapper for :attr:`numpy.ndarray.conj` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.conjugate`
      - Wrapper for :attr:`numpy.ndarray.conjugate` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.copy`
      - Wrapper for :attr:`numpy.ndarray.copy` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.cumprod`
      - Wrapper for :attr:`numpy.ndarray.cumprod` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.cumsum`
      - Wrapper for :attr:`numpy.ndarray.cumsum` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.diagonal`
      - Wrapper for :attr:`numpy.ndarray.diagonal` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.fill`
      - Wrapper for :attr:`numpy.ndarray.fill` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.flatten`
      - Wrapper for :attr:`numpy.ndarray.flatten` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.max`
      - Wrapper for :attr:`numpy.ndarray.max` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.mean`
      - Wrapper for :attr:`numpy.ndarray.mean` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.min`
      - Wrapper for :attr:`numpy.ndarray.min` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.nonzero`
      - Wrapper for :attr:`numpy.ndarray.nonzero` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.ok`
      - Check the field
    * - Method
      - :func:`~pyarts.arts.GriddedField2.prod`
      - Wrapper for :attr:`numpy.ndarray.prod` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.ravel`
      - Wrapper for :attr:`numpy.ndarray.ravel` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts.arts.GriddedField2.repeat`
      - Wrapper for :attr:`numpy.ndarray.repeat` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.reshape`
      - Wrapper for :attr:`numpy.ndarray.reshape` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.round`
      - Wrapper for :attr:`numpy.ndarray.round` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.savexml`
      - Saves variable to file
    * - Method
      - :func:`~pyarts.arts.GriddedField2.squeeze`
      - Wrapper for :attr:`numpy.ndarray.squeeze` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.std`
      - Wrapper for :attr:`numpy.ndarray.std` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.sum`
      - Wrapper for :attr:`numpy.ndarray.sum` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.to_dict`
      - Convert object to :class:`dict`.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.to_xarray`
      - Create :class:`xarray.DataArray` from the object.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.tolist`
      - Wrapper for :attr:`numpy.ndarray.tolist` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.trace`
      - Wrapper for :attr:`numpy.ndarray.trace` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.transpose`
      - Wrapper for :attr:`numpy.ndarray.transpose` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.GriddedField2.var`
      - Wrapper for :attr:`numpy.ndarray.var` using ARTS types.
    * - Static Method
      - :func:`~pyarts.arts.GriddedField2.from_dict`
      - Create object from :class:`dict`.
    * - Static Method
      - :func:`~pyarts.arts.GriddedField2.from_xarray`
      - Create object from :class:`xarray.DataArray`.
    * - Static Method
      - :func:`~pyarts.arts.GriddedField2.fromxml`
      - Create variable from file
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.T`
      - Wrapper for :attr:`numpy.ndarray.T` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.data`
      - The data itself
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.dataname`
      - Name of the data
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.dtype`
      - Wrapper for :attr:`numpy.ndarray.dtype` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.gridnames`
      - The grid names
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.grids`
      - The grid of the data
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.imag`
      - Wrapper for :attr:`numpy.ndarray.imag` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.itemsize`
      - Wrapper for :attr:`numpy.ndarray.itemsize` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.nbytes`
      - Wrapper for :attr:`numpy.ndarray.nbytes` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.ndim`
      - Wrapper for :attr:`numpy.ndarray.ndim` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.real`
      - Wrapper for :attr:`numpy.ndarray.real` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.shape`
      - Wrapper for :attr:`numpy.ndarray.shape` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.size`
      - Wrapper for :attr:`numpy.ndarray.size` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.strides`
      - Wrapper for :attr:`numpy.ndarray.strides` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.GriddedField2.value`
      - A :class:`~numpy.ndarray` of the object.
    * - Static Data
      - ``pyarts.arts.GriddedField2.dim``
      - 2 - :class:`~int`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__abs__`
      - Allows `abs(self)`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__add__`
      - Allows `self + value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__and__`
      - Allows `self and value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__array__`
      - Allows :func:`~numpy.array` to be called with the object.
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__contains__`
      - Allows `key in self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__divmod__`
      - Allows `divmod(self, value)`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__eq__`
      - Allows `self == value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__floordiv__`
      - Allows `self // value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__ge__`
      - Allows `self >= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__getitem__`
      - Allows `self[key]`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__getstate__`
      - Helper for pickle.
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__gt__`
      - Allows `self > value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__iadd__`
      - Allows `self += value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__iand__`
      - Allows `self &= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__ifloordiv__`
      - Allows `self //= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__imatmul__`
      - Allows `self @= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__imod__`
      - Allows `self %= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__imul__`
      - Allows `self *= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__init__`
      - __init__(self, arg: pyarts.arts.GriddedField2) -> None
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__ior__`
      - Allows `self |= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__ipow__`
      - Allows `self **= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__isub__`
      - Allows `self -= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__iter__`
      - Allows `iter(self)`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__itruediv__`
      - Allows `self /= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__le__`
      - Allows `self <= value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__len__`
      - Allows `len(self)`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__lt__`
      - Allows `self < value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__matmul__`
      - Allows `self @ value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__mod__`
      - Allows `self % value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__mul__`
      - Allows `self * value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__ne__`
      - Allows `self != value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__or__`
      - Allows `self | value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__pow__`
      - Allows `self ** value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__radd__`
      - Allows `value + self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rand__`
      - Allows `value & self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rdivmod__`
      - Allows `value / self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rfloordiv__`
      - Allows `value // self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rmatmul__`
      - Allows `value @ self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rmod__`
      - Allows `value % self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rmul__`
      - Allows `value * self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__ror__`
      - Allows `value | self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rpow__`
      - Allows `value ** self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rsub__`
      - Allows `value - self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__rtruediv__`
      - Allows `value / self`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__setitem__`
      - Allows `self[key] = value`
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__str__`
      - __str__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.GriddedField2.__truediv__`
      - Allows `self / value`

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: GriddedField2.conj
  .. automethod:: GriddedField2.conjugate
  .. automethod:: GriddedField2.copy
  .. automethod:: GriddedField2.cumprod
  .. automethod:: GriddedField2.cumsum
  .. automethod:: GriddedField2.diagonal
  .. automethod:: GriddedField2.fill
  .. automethod:: GriddedField2.flatten
  .. automethod:: GriddedField2.max
  .. automethod:: GriddedField2.mean
  .. automethod:: GriddedField2.min
  .. automethod:: GriddedField2.nonzero
  .. automethod:: GriddedField2.ok
  .. automethod:: GriddedField2.prod
  .. automethod:: GriddedField2.ravel
  .. automethod:: GriddedField2.readxml
  .. automethod:: GriddedField2.repeat
  .. automethod:: GriddedField2.reshape
  .. automethod:: GriddedField2.round
  .. automethod:: GriddedField2.savexml
  .. automethod:: GriddedField2.squeeze
  .. automethod:: GriddedField2.std
  .. automethod:: GriddedField2.sum
  .. automethod:: GriddedField2.to_dict
  .. automethod:: GriddedField2.to_xarray
  .. automethod:: GriddedField2.tolist
  .. automethod:: GriddedField2.trace
  .. automethod:: GriddedField2.transpose
  .. automethod:: GriddedField2.var

  .. rubric:: Static Methods

  .. automethod:: GriddedField2.from_dict
  .. automethod:: GriddedField2.from_xarray
  .. automethod:: GriddedField2.fromxml

  .. rubric:: Attributes

  .. autoattribute:: GriddedField2.T
  .. autoattribute:: GriddedField2.data
  .. autoattribute:: GriddedField2.dataname
  .. autoattribute:: GriddedField2.dtype
  .. autoattribute:: GriddedField2.gridnames
  .. autoattribute:: GriddedField2.grids
  .. autoattribute:: GriddedField2.imag
  .. autoattribute:: GriddedField2.itemsize
  .. autoattribute:: GriddedField2.nbytes
  .. autoattribute:: GriddedField2.ndim
  .. autoattribute:: GriddedField2.real
  .. autoattribute:: GriddedField2.shape
  .. autoattribute:: GriddedField2.size
  .. autoattribute:: GriddedField2.strides
  .. autoattribute:: GriddedField2.value

  .. rubric:: Operators

  .. automethod:: GriddedField2.__abs__
  .. automethod:: GriddedField2.__add__
  .. automethod:: GriddedField2.__and__
  .. automethod:: GriddedField2.__array__
  .. automethod:: GriddedField2.__contains__
  .. automethod:: GriddedField2.__divmod__
  .. automethod:: GriddedField2.__eq__
  .. automethod:: GriddedField2.__floordiv__
  .. automethod:: GriddedField2.__format__
  .. automethod:: GriddedField2.__ge__
  .. automethod:: GriddedField2.__getitem__
  .. automethod:: GriddedField2.__getstate__
  .. automethod:: GriddedField2.__gt__
  .. automethod:: GriddedField2.__hash__
  .. automethod:: GriddedField2.__iadd__
  .. automethod:: GriddedField2.__iand__
  .. automethod:: GriddedField2.__ifloordiv__
  .. automethod:: GriddedField2.__imatmul__
  .. automethod:: GriddedField2.__imod__
  .. automethod:: GriddedField2.__imul__
  .. automethod:: GriddedField2.__init__
  .. automethod:: GriddedField2.__ior__
  .. automethod:: GriddedField2.__ipow__
  .. automethod:: GriddedField2.__isub__
  .. automethod:: GriddedField2.__iter__
  .. automethod:: GriddedField2.__itruediv__
  .. automethod:: GriddedField2.__le__
  .. automethod:: GriddedField2.__len__
  .. automethod:: GriddedField2.__lt__
  .. automethod:: GriddedField2.__matmul__
  .. automethod:: GriddedField2.__mod__
  .. automethod:: GriddedField2.__mul__
  .. automethod:: GriddedField2.__ne__
  .. automethod:: GriddedField2.__or__
  .. automethod:: GriddedField2.__pow__
  .. automethod:: GriddedField2.__radd__
  .. automethod:: GriddedField2.__rand__
  .. automethod:: GriddedField2.__rdivmod__
  .. automethod:: GriddedField2.__repr__
  .. automethod:: GriddedField2.__rfloordiv__
  .. automethod:: GriddedField2.__rmatmul__
  .. automethod:: GriddedField2.__rmod__
  .. automethod:: GriddedField2.__rmul__
  .. automethod:: GriddedField2.__ror__
  .. automethod:: GriddedField2.__rpow__
  .. automethod:: GriddedField2.__rsub__
  .. automethod:: GriddedField2.__rtruediv__
  .. automethod:: GriddedField2.__setitem__
  .. automethod:: GriddedField2.__str__
  .. automethod:: GriddedField2.__truediv__