Propmat
#######

.. currentmodule:: pyarts3.arts

.. autoclass:: Propmat

  .. rubric:: Overview

  .. list-table::

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

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

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

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

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

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

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

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

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

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

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

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

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


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