SpecmatMatrix
#############

.. currentmodule:: pyarts3.arts

.. autoclass:: SpecmatMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: SpecmatMatrix.fromxml

  .. rubric:: Attributes

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

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

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

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

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

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

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

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

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

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

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


  .. rubric:: Operators

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