Index
#####

.. currentmodule:: pyarts.arts

.. autoclass:: Index

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts.arts.Index.conj`
      - Wrapper for :attr:`numpy.ndarray.conj` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.conjugate`
      - Wrapper for :attr:`numpy.ndarray.conjugate` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.copy`
      - Wrapper for :attr:`numpy.ndarray.copy` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.cumprod`
      - Wrapper for :attr:`numpy.ndarray.cumprod` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.cumsum`
      - Wrapper for :attr:`numpy.ndarray.cumsum` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.diagonal`
      - Wrapper for :attr:`numpy.ndarray.diagonal` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.fill`
      - Wrapper for :attr:`numpy.ndarray.fill` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.flatten`
      - Wrapper for :attr:`numpy.ndarray.flatten` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.max`
      - Wrapper for :attr:`numpy.ndarray.max` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.mean`
      - Wrapper for :attr:`numpy.ndarray.mean` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.min`
      - Wrapper for :attr:`numpy.ndarray.min` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.nonzero`
      - Wrapper for :attr:`numpy.ndarray.nonzero` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.prod`
      - Wrapper for :attr:`numpy.ndarray.prod` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.ravel`
      - Wrapper for :attr:`numpy.ndarray.ravel` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts.arts.Index.repeat`
      - Wrapper for :attr:`numpy.ndarray.repeat` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.reshape`
      - Wrapper for :attr:`numpy.ndarray.reshape` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.round`
      - Wrapper for :attr:`numpy.ndarray.round` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.savexml`
      - Saves variable to file
    * - Method
      - :func:`~pyarts.arts.Index.squeeze`
      - Wrapper for :attr:`numpy.ndarray.squeeze` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.std`
      - Wrapper for :attr:`numpy.ndarray.std` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.sum`
      - Wrapper for :attr:`numpy.ndarray.sum` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.tolist`
      - Wrapper for :attr:`numpy.ndarray.tolist` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.trace`
      - Wrapper for :attr:`numpy.ndarray.trace` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.transpose`
      - Wrapper for :attr:`numpy.ndarray.transpose` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Index.var`
      - Wrapper for :attr:`numpy.ndarray.var` using ARTS types.
    * - Static Method
      - :func:`~pyarts.arts.Index.fromxml`
      - Create variable from file
    * - Attribute
      - :attr:`~pyarts.arts.Index.T`
      - Wrapper for :attr:`numpy.ndarray.T` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.dtype`
      - Wrapper for :attr:`numpy.ndarray.dtype` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.imag`
      - Wrapper for :attr:`numpy.ndarray.imag` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.itemsize`
      - Wrapper for :attr:`numpy.ndarray.itemsize` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.nbytes`
      - Wrapper for :attr:`numpy.ndarray.nbytes` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.ndim`
      - Wrapper for :attr:`numpy.ndarray.ndim` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.real`
      - Wrapper for :attr:`numpy.ndarray.real` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.shape`
      - Wrapper for :attr:`numpy.ndarray.shape` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.size`
      - Wrapper for :attr:`numpy.ndarray.size` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.strides`
      - Wrapper for :attr:`numpy.ndarray.strides` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Index.value`
      - A :class:`~numpy.ndarray` of the object.
    * - Operator
      - :func:`~pyarts.arts.Index.__abs__`
      - Allows `abs(self)`
    * - Operator
      - :func:`~pyarts.arts.Index.__add__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__and__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__array__`
      - Returns a :class:`~numpy.ndarray` of the object.
    * - Operator
      - :func:`~pyarts.arts.Index.__contains__`
      - Allows `key in self`
    * - Operator
      - :func:`~pyarts.arts.Index.__divmod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__eq__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__floordiv__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts.arts.Index.__ge__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__getitem__`
      - Allows `self[key]`
    * - Operator
      - :func:`~pyarts.arts.Index.__getstate__`
      - __getstate__(self) -> tuple[int]
    * - Operator
      - :func:`~pyarts.arts.Index.__gt__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__hash__`
      - Allows hashing
    * - Operator
      - :func:`~pyarts.arts.Index.__iadd__`
      - Allows `self += value`
    * - Operator
      - :func:`~pyarts.arts.Index.__iand__`
      - Allows `self &= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__ifloordiv__`
      - Allows `self //= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__imatmul__`
      - Allows `self @= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__imod__`
      - Allows `self %= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__imul__`
      - Allows `self *= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__init__`
      - __init__(self, arg: pyarts.arts.Index) -> None
    * - Operator
      - :func:`~pyarts.arts.Index.__ior__`
      - Allows `self |= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__ipow__`
      - Allows `self **= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__isub__`
      - Allows `self -= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__iter__`
      - Allows `iter(self)`
    * - Operator
      - :func:`~pyarts.arts.Index.__itruediv__`
      - Allows `self /= value`
    * - Operator
      - :func:`~pyarts.arts.Index.__le__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__len__`
      - Allows `len(self)`
    * - Operator
      - :func:`~pyarts.arts.Index.__lt__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__matmul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__mod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__mul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__ne__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__or__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__pow__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__radd__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rand__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rdivmod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.Index.__rfloordiv__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rmatmul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rmod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rmul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__ror__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rpow__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rsub__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__rtruediv__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Index.__setitem__`
      - Allows `self[key] = value`
    * - Operator
      - :func:`~pyarts.arts.Index.__setstate__`
      - __setstate__(self, arg: tuple[int], /) -> None
    * - Operator
      - :func:`~pyarts.arts.Index.__str__`
      - __str__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.Index.__truediv__`
      - Overloaded function.

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: Index.fromxml

  .. rubric:: Attributes

  .. autoattribute:: Index.T
  .. autoattribute:: Index.dtype
  .. autoattribute:: Index.imag
  .. autoattribute:: Index.itemsize
  .. autoattribute:: Index.nbytes
  .. autoattribute:: Index.ndim
  .. autoattribute:: Index.real
  .. autoattribute:: Index.shape
  .. autoattribute:: Index.size
  .. autoattribute:: Index.strides
  .. autoattribute:: Index.value

  .. rubric:: Operators

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