Propmat
#######

.. currentmodule:: pyarts.arts

.. autoclass:: Propmat

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: Propmat.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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