Stokvec
#######

.. currentmodule:: pyarts.arts

.. autoclass:: Stokvec

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: Stokvec.cirpol
  .. automethod:: Stokvec.fromxml
  .. automethod:: Stokvec.linpol

  .. rubric:: Attributes

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

  .. rubric:: Operators

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