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

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`list`[`Block`]	`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[pyarts3.arts.ArrayOfBlock, pyarts3.arts.ArrayOfBlock]
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[pyarts3.arts.ArrayOfBlock, pyarts3.arts.ArrayOfBlock], /) -> 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.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

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, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.
clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

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

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.
Returns:: artstype – The variable created from the file.
Return type:: T

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[pyarts3.arts.ArrayOfBlock, pyarts3.arts.ArrayOfBlock]

__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[pyarts3.arts.ArrayOfBlock, pyarts3.arts.ArrayOfBlock], /) → None

__str__(self) → str