Stokvec
#######

.. currentmodule:: pyarts3.arts

.. autoclass:: Stokvec

  .. rubric:: Overview

  .. list-table::

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

  .. 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

  .. attribute:: Stokvec.T
     :type: object
     
     See :attr:`numpy.ndarray.T`.
     
     .. :class:`object`

  .. attribute:: Stokvec.dtype
     :type: object
     
     See :attr:`numpy.ndarray.dtype`.
     
     .. :class:`object`

  .. attribute:: Stokvec.imag
     :type: object
     
     See :attr:`numpy.ndarray.imag`.
     
     .. :class:`object`

  .. attribute:: Stokvec.itemsize
     :type: object
     
     See :attr:`numpy.ndarray.itemsize`.
     
     .. :class:`object`

  .. attribute:: Stokvec.nbytes
     :type: object
     
     See :attr:`numpy.ndarray.nbytes`.
     
     .. :class:`object`

  .. attribute:: Stokvec.ndim
     :type: object
     
     See :attr:`numpy.ndarray.ndim`.
     
     .. :class:`object`

  .. attribute:: Stokvec.real
     :type: object
     
     See :attr:`numpy.ndarray.real`.
     
     .. :class:`object`

  .. attribute:: Stokvec.shape
     :type: object
     
     See :attr:`numpy.ndarray.shape`.
     
     .. :class:`object`

  .. attribute:: Stokvec.size
     :type: object
     
     See :attr:`numpy.ndarray.size`.
     
     .. :class:`object`

  .. attribute:: Stokvec.strides
     :type: object
     
     See :attr:`numpy.ndarray.strides`.
     
     .. :class:`object`

  .. attribute:: Stokvec.value
     :type: ~numpy.ndarray
     
     A :class:`~numpy.ndarray` of the object.
     
     .. :class:`~numpy.ndarray`


  .. 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__