CIARecord

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

Contains information to compute collision induced absorption (CIA) for a pair of species.

A record holds a list of GriddedField2 objects, each which describe a separate band of absorption with dimensions of frequency times temperature. The Matrix objects in the GriddedField2 simply holds data to be interpolated in the frequency and temperature with physical units of [m \(^5\) per molecule \(^2\)].

Overview

Method	`compute_abs()`	Computes the collision-induced absorption in 1/m
Method	`propagation_matrix()`	Computes the collision-induced absorption in 1/m
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`ArrayOfGriddedField2`	`data`	Data by bands
`tuple`[`pyarts3.arts.SpeciesEnum`, `pyarts3.arts.SpeciesEnum`]	`specs`	The two species
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	__getstate__(self) -> tuple[pyarts3.arts.ArrayOfGriddedField2, list[pyarts3.arts.SpeciesEnum]]
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg0: pyarts3.arts.ArrayOfGriddedField2, arg1: pyarts3.arts.SpeciesEnum, arg2: pyarts3.arts.SpeciesEnum, /) -> 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.ArrayOfGriddedField2, collections.abc.Sequence[pyarts3.arts.SpeciesEnum]], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None
__init__(self, arg: pyarts3.arts.CIARecord) → None
__init__(self, arg0: pyarts3.arts.ArrayOfGriddedField2, arg1: pyarts3.arts.SpeciesEnum, arg2: pyarts3.arts.SpeciesEnum, /) → None

Methods

compute_abs(self, T: float, P: float, X0: float, X1: float, f: pyarts3.arts.Vector, T_extrapolfac: float = 0.0, robust: int = 1) → pyarts3.arts.Vector

Computes the collision-induced absorption in 1/m

Parameters:

T (Numeric) – Temperature [K]
P (Numeric) – Pressure [Pa]
X0 (Numeric) – VMR of species 1 [-]
X1 (Numeric) – VMR of species 2 [-]
f (Vector) – Frequency grid [Hz]
T_extrapolfac (Numeric, optional) – Extrapolation in temperature. The default is 0
robust (Index, optional) – Returns NaN instead of throwing if it evaluates true. The default is 1

Returns:

abs – Absorption profile [1/m]

Return type:

Vector

propagation_matrix(self, f: pyarts3.arts.AscendingGrid, atm: pyarts3.arts.AtmPoint, T_extrapolfac: float = 0.0, robust: int = 1) → pyarts3.arts.PropmatVector

Computes the collision-induced absorption in 1/m

Parameters:

f (AscendingGrid) – Frequency grid [Hz]
atm (AtmPoint) – Atmospheric point
T_extrapolfac (Numeric, optional) – Extrapolation in temperature. The default is 0
robust (Index, optional) – Returns NaN instead of throwing if it evaluates true. The default is 1

Returns:

abs – Absorption profile [1/m]

Return type:

PropmatVector

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: