CIARecord

class pyarts.arts.CIARecord(*args, **kwargs)

Contains information to compute collision induced absorption for a pair of species

Holds an the record data in a gridded field with grids of temperature and frequency in units of m^5 molec^(-2)

Workspace methods that require CIARecord

Overview

Method

compute_abs()

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

Attribute

data

ArrayOfGriddedField2 Data by bands

Attribute

specs

list The two species

Operator

__eq__()

Return self==value.

Operator

__ge__()

Return self>=value.

Operator

__getstate__()

__getstate__(self) -> tuple[pyarts.arts.ArrayOfGriddedField2, std::array<SpeciesEnum, 2ul>]

Operator

__gt__()

Return self>value.

Operator

__hash__()

Return hash(self).

Operator

__le__()

Return self<=value.

Operator

__lt__()

Return self<value.

Operator

__ne__()

Return self!=value.

Operator

__setstate__()

__setstate__(self, arg: tuple[pyarts.arts.ArrayOfGriddedField2, std::array<SpeciesEnum, 2ul>], /) -> None

Constructors

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

Methods

compute_abs(self, T: float, P: float, X0: float, X1: float, f: pyarts.arts.Vector, T_extrapolfac: float = 0.0, robust: int = 1) pyarts.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

readxml(self, file: str) None

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) None

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) pyarts.arts.CIARecord

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

data

ArrayOfGriddedField2 Data by bands

specs

list The two species

Operators

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__getstate__(self) tuple[pyarts.arts.ArrayOfGriddedField2, std::array<SpeciesEnum, 2ul>]
__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__setstate__(self, arg: tuple[pyarts.arts.ArrayOfGriddedField2, std::array<SpeciesEnum, 2ul>], /) None