Specmat
#######

.. currentmodule:: pyarts3.arts

.. autoclass:: Specmat

  .. rubric:: Overview

  .. list-table::

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

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

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

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

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

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

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

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

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

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

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

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

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


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