XsecRecord

class pyarts3.arts.XsecRecord(*args, **kwargs)

A single cross-section record

These cross-section records contains information about the valid temperature and pressure ranges as well as well as the fitting coefficients used to compute and interpolate the cross-section to other temperatures and pressures

Overview

Method	compute_abs()	Computes the Hitran cross-section absorption in 1/m
Method	propagation_matrix()	Computes the Hitran cross-section absorption in 1/m
Method	readxml()	Read variable from file
Method	savexml()	Saves variable to file
Method	to_dict()	Convert object to dict.
Method	to_netcdf()	Save XsecRecord to NetCDF file.
Method	to_xarray()	Convert XsecRecord to xarray.DataArray().
Static Method	from_dict()	Create object from dict.
Static Method	from_netcdf()	Create an XsecRecord from a NetCDF file.
Static Method	from_xarray()	Create XsecRecord from xarray.DataArray().
Static Method	fromxml()	Create variable from file
Attribute	fitcoeffs	Fit coefficients
Attribute	fitmaxpressures	Fit coefficients
Attribute	fitmaxtemperatures	Fit coefficients
Attribute	fitminpressures	Fit coefficients
Attribute	fitmintemperatures	Fit coefficients
Attribute	species	The species
Static Data	pyarts3.arts.XsecRecord.version	2 (int)
Operator	__eq__()	Allows self == value
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getstate__()	__getstate__(self) -> tuple[int, pyarts3.arts.SpeciesEnum, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.ArrayOfGriddedField1Named]
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: pyarts3.arts.XsecRecord) -> 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[int, pyarts3.arts.SpeciesEnum, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.ArrayOfGriddedField1Named], /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

Methods

compute_abs(self, T: float, P: float, VMR: float, f: pyarts3.arts.Vector) → pyarts3.arts.Vector

Computes the Hitran cross-section absorption in 1/m

Parameters:

• T (Numeric) – Temperature [K]

• P (Numeric) – Pressure [Pa]

• VMR (Numeric) – VMR of species [-]

• f (Vector) – Frequency grid [Hz]

Returns:

abs – Absorption profile [1/m]

Return type:

Vector

propagation_matrix(self, f: pyarts3.arts.AscendingGrid, atm: pyarts3.arts.AtmPoint) → pyarts3.arts.PropmatVector

Computes the Hitran cross-section absorption in 1/m

Parameters:

• f (AscendingGrid) – Frequency grid [Hz]

• atm (AtmPoint) – Atmospheric point

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

On Error:

Throws RuntimeError for any failure to read

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

to_dict(self) → dict

Convert object to dict.

to_netcdf(self, arg: object, /) → object

Save XsecRecord to NetCDF file.

to_xarray(self) → object

Convert XsecRecord to xarray.DataArray().

Static Methods

from_dict(arg: dict, /) → pyarts3.arts.XsecRecord

Create object from dict.

from_netcdf(arg: object, /) → object

Create an XsecRecord from a NetCDF file.

from_xarray(arg: object, /) → object

Create XsecRecord from xarray.DataArray().

fromxml(file: str) → pyarts3.arts.XsecRecord

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

fitcoeffs: ArrayOfGriddedField2

Fit coefficients

fitmaxpressures: ArrayOfGriddedField2

Fit coefficients

fitmaxtemperatures: ArrayOfGriddedField2

Fit coefficients

fitminpressures: ArrayOfGriddedField2

Fit coefficients

fitmintemperatures: ArrayOfGriddedField2

Fit coefficients

species: SpeciesEnum

The species

Operators

__eq__(self, value: pyarts3.arts.XsecRecord) → bool

Allows self == value

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

__ge__(value, /)

Return self>=value.

__getstate__(self) → tuple[int, pyarts3.arts.SpeciesEnum, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.ArrayOfGriddedField1Named]

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

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

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__setstate__(self, arg: tuple[int, pyarts3.arts.SpeciesEnum, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.Vector, pyarts3.arts.ArrayOfGriddedField1Named], /) → None

__str__(self) → str