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

.. currentmodule:: pyarts.arts

.. autoclass:: SpecmatMatrix

  .. rubric:: Overview

  .. list-table::

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

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

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

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