LineShapeModel

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

Line shape model

Overview

Method	`D0()`	Computes the D0 coefficient
Method	`D2()`	Computes the D2 coefficient
Method	`DV()`	Computes the DV coefficient
Method	`ETA()`	Computes the ETA coefficient
Method	`FVC()`	Computes the FVC coefficient
Method	`G()`	Computes the G coefficient
Method	`G0()`	Computes the G0 coefficient
Method	`G2()`	Computes the G2 coefficient
Method	`Y()`	Computes the Y coefficient
Method	`readxml()`	Read variable from file.
Method	`remove()`	Remove a type of variable from the line shape model.
Method	`remove_zeros()`	Remove zero coefficients from the line shape model
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`Numeric`	`T0`	The reference temperature [K]
`dict`[`SpeciesEnum`, `LineShapeSpeciesModel`]	`single_models`	The single models
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.LineShapeModel) -> 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: LineShapeModel) → None

Methods

D0(self, atm: AtmPoint) → float

Computes the D0 coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The D0 coefficient(s) [Hz]
Return type:: ~pyarts3.arts.Numeric or array_like

D2(self, atm: AtmPoint) → float

Computes the D2 coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The D2 coefficient(s) [Hz]
Return type:: ~pyarts3.arts.Numeric or array_like

DV(self, atm: AtmPoint) → float

Computes the DV coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The DV coefficient(s) [Hz]
Return type:: ~pyarts3.arts.Numeric or array_like

ETA(self, atm: AtmPoint) → float

Computes the ETA coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The ETA coefficient(s) [dimensionless]
Return type:: ~pyarts3.arts.Numeric or array_like

FVC(self, atm: AtmPoint) → float

Computes the FVC coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The FVC coefficient(s) [Hz]
Return type:: ~pyarts3.arts.Numeric or array_like

G(self, atm: AtmPoint) → float

Computes the G coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The G coefficient(s) [dimensionless]
Return type:: ~pyarts3.arts.Numeric or array_like

G0(self, atm: AtmPoint) → float

Computes the G0 coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The G0 coefficient(s) [Hz]
Return type:: ~pyarts3.arts.Numeric or array_like

G2(self, atm: AtmPoint) → float

Computes the G2 coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The G2 coefficient(s) [Hz]
Return type:: ~pyarts3.arts.Numeric or array_like

Y(self, atm: AtmPoint) → float

Computes the Y coefficient

Parameters:: atm (AtmPoint) – The atmospheric point - must contain pressure and temperature and VMR of all species in the model
Returns:: The Y coefficient(s) [dimensionless]
Return type:: ~pyarts3.arts.Numeric or array_like

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

remove(self, x: LineShapeModelVariable) → None

Remove a type of variable from the line shape model.

Parameters:: x (LineShapeModelVariable) – The variable to remove

remove_zeros(self) → None: Remove zero coefficients from the line shape model

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) → LineShapeModel

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.

Attributes

T0: Numeric: The reference temperature [K]

single_models: dict[SpeciesEnum, LineShapeSpeciesModel]: The single models

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: LineShapeModel) → None

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

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

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

__repr__(self) → str

__str__(self) → str