CovarianceMatrix

class pyarts3.arts.CovarianceMatrix(*args, **kwargs)

A covariance matrix is a square matrix that describes the covariance of some property.

Please see the different workspace variables of this type for more information.

In ARTS, this square matrix is represented by two lists of Block. These are used to give both the covariance matrix and the inverse covariance matrix. The block-structure allows for efficient storage and computation of the covariance matrix.

Workspace variables of type CovarianceMatrix

measurement_vector_error_covariance_matrix model_state_covariance_matrix

Overview

Method	readxml()	Read variable from file
Method	savexml()	Saves variable to file
Static Method	fromxml()	Create variable from file
Attribute	blocks	The blocks
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getstate__()	__getstate__(self) -> tuple[list[pyarts3.arts.Block], list[pyarts3.arts.Block]]
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: pyarts3.arts.CovarianceMatrix) -> None
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__setstate__()	__setstate__(self, arg: tuple[collections.abc.Sequence[pyarts3.arts.Block], collections.abc.Sequence[pyarts3.arts.Block]], /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

__init__(self, arg: pyarts3.arts.CovarianceMatrix) → None

Methods

readxml(self, file: str) → str

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file

Parameters:

• file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files

• type (str) – Type of file to save. See FileType for options.

• clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) → pyarts3.arts.CovarianceMatrix

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

blocks: list[Block]

The blocks

Operators

__eq__(value, /)

Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /)

Return self>=value.

__getstate__(self) → tuple[list[pyarts3.arts.Block], list[pyarts3.arts.Block]]

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

__init__(self, arg: pyarts3.arts.CovarianceMatrix) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__setstate__(self, arg: tuple[collections.abc.Sequence[pyarts3.arts.Block], collections.abc.Sequence[pyarts3.arts.Block]], /) → None

__str__(self) → str