TransmittanceMatrix

class pyarts3.arts.TransmittanceMatrix(*args, **kwargs)

Transmittance matrix and derivatives.

Workspace variables of type TransmittanceMatrix

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`MuelmatMatrix`	`L`	The linear evolution Mueller matrix; shape [nf, np] if defined
`MuelmatMatrix`	`P`	The cumulative from background transmittance Mueller matrix; shape [nf, np] if defined
`MuelmatMatrix`	`T`	The transmittance Mueller matrix; shape [nf, np] if defined
`MuelmatTensor4`	`dL`	The derivative of the linear evolution Mueller matrix; shape [2, nf, np, nq] if defined
`MuelmatTensor4`	`dT`	The derivative of the transmittance Mueller matrix; shape [2, nf, np, nq] if defined
`TransmittanceOption`	`opt`	The option for the transmittance matrix calculations
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.TransmittanceMatrix) -> None
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__str__()`	__str__(self) -> str

Constructors

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

Create variable from file.

Attributes

L: MuelmatMatrix: The linear evolution Mueller matrix; shape [nf, np] if defined

P: MuelmatMatrix: The cumulative from background transmittance Mueller matrix; shape [nf, np] if defined

T: MuelmatMatrix: The transmittance Mueller matrix; shape [nf, np] if defined

dL: MuelmatTensor4: The derivative of the linear evolution Mueller matrix; shape [2, nf, np, nq] if defined

dT: MuelmatTensor4: The derivative of the transmittance Mueller matrix; shape [2, nf, np, nq] if defined

opt: TransmittanceOption: The option for the transmittance matrix calculations

Operators