LineShapeSpeciesModel

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

Line shape model for a species

Overview

Method	`D0()`	Computes the D0 coefficient for the given conditions.
Method	`D2()`	Computes the D2 coefficient for the given conditions.
Method	`DV()`	Computes the DV coefficient for the given conditions.
Method	`ETA()`	Computes the ETA coefficient for the given conditions.
Method	`FVC()`	Computes the FVC coefficient for the given conditions.
Method	`G()`	Computes the G coefficient for the given conditions.
Method	`G0()`	Computes the G0 coefficient for the given conditions.
Method	`G2()`	Computes the G2 coefficient for the given conditions.
Method	`Y()`	Computes the Y coefficient for the given conditions.
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`dict`[`tuple`[`LineShapeModelVariable`, `TemperatureModel`]:class:]	`data`	The data
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	Return self>=value.
Operator	`__getitem__()`	`__getitem__(self, arg: object, /) -> object`
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	`__init__(self, arg: pyarts3.arts.LineShapeSpeciesModel) -> None`
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__setitem__()`	`__setitem__(self, arg0: object, arg1: object, /) -> None`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

__init__(self) → None
__init__(self, arg: LineShapeSpeciesModel) → None

Methods

D0(self, T0: object, T: object, P: object) → object

Computes the D0 coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The D0 coefficient(s) [Hz]

Return type:

~pyarts3.arts.Numeric or array_like

D2(self, T0: object, T: object, P: object) → object

Computes the D2 coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The D2 coefficient(s) [Hz]

Return type:

~pyarts3.arts.Numeric or array_like

DV(self, T0: object, T: object, P: object) → object

Computes the DV coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The DV coefficient(s) [Hz]

Return type:

~pyarts3.arts.Numeric or array_like

ETA(self, T0: object, T: object, P: object) → object

Computes the ETA coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The ETA coefficient(s) [dimensionless]

Return type:

~pyarts3.arts.Numeric or array_like

FVC(self, T0: object, T: object, P: object) → object

Computes the FVC coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The FVC coefficient(s) [Hz]

Return type:

~pyarts3.arts.Numeric or array_like

G(self, T0: object, T: object, P: object) → object

Computes the G coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The G coefficient(s) [dimensionless]

Return type:

~pyarts3.arts.Numeric or array_like

G0(self, T0: object, T: object, P: object) → object

Computes the G0 coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The G0 coefficient(s) [Hz]

Return type:

~pyarts3.arts.Numeric or array_like

G2(self, T0: object, T: object, P: object) → object

Computes the G2 coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

Returns:

The G2 coefficient(s) [Hz]

Return type:

~pyarts3.arts.Numeric or array_like

Y(self, T0: object, T: object, P: object) → object

Computes the Y coefficient for the given conditions.

Parameters:

T0 (~pyarts3.arts.Numeric or array_like) – The reference temperature(s) [K]
T (~pyarts3.arts.Numeric or array_like) – The temperature(s) [K]
P (~pyarts3.arts.Numeric or array_like) – The pressure(s) [Pa]

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

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

Create variable from file.

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

Attributes

data: dict[tuple[LineShapeModelVariable, TemperatureModel]]: The data

Operators

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

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

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

__getitem__(self, arg: object, /) → object

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

__hash__(): Return hash(self).

__init__(self) → None
__init__(self, arg: LineShapeSpeciesModel) → None

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

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

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

__repr__(self) → str

__setitem__(self, arg0: object, arg1: object, /) → None

__str__(self) → str