TransmittanceMatrix

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

Transmittance matrix and derivatives.

Sizes

A variable x of this group may name 3 dimensions, read as x.shape()[0], x.shape()[1] and x.shape()[2].

Invariant

A variable x of this group has members that agree with each other for its transmittance option.

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
`StokvecMatrix`	`L_diag_m1`	The accurately cached diagonal of L-I; 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
`StokvecMatrix`	`T_diag_m1`	The accurately cached diagonal of T-I; 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

__init__(self) → None
__init__(self, arg: pyarts3.arts.TransmittanceMatrix) → 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.TransmittanceMatrix

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

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

L_diag_m1: StokvecMatrix: The accurately cached diagonal of L-I; 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

T_diag_m1: StokvecMatrix: The accurately cached diagonal of T-I; 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

__eq__(value, /): Return self==value.

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

__ge__(value, /): Return self>=value.

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

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

__le__(value, /): Return self<=value.

__lt__(value, /): Return self<value.

__ne__(value, /): Return self!=value.

__repr__(self) → str

__str__(self) → str