Specmat
#######

.. currentmodule:: pyarts.arts

.. autoclass:: Specmat

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: Specmat.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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