QuantumLevelIdentifier

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

An ID for an absorption species state

It contains the level information of a quantum state.

It can identify:

a species
an isotopologue of a species
the energy level of absorption band(s) of an isotopologue
the energy level of absorption line(s) of an isotopologue

When used in the context of the atmosphere via AtmField or AtmPoint, this is used to store Non-LTE data - i.e., the direct ratios of upper and lower states (which are instead computed on-the-fly when LTE conditions are assumed).

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`SpeciesIsotope`	`isot`	Isotopologue
`QuantumLevel`	`state`	State
Operator	`__eq__()`	`__eq__(self, arg: pyarts3.arts.QuantumLevelIdentifier, /) -> bool`
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	`__ge__(self, arg: pyarts3.arts.QuantumLevelIdentifier, /) -> bool`
Operator	`__gt__()`	`__gt__(self, arg: pyarts3.arts.QuantumLevelIdentifier, /) -> bool`
Operator	`__hash__()`	`__hash__(self) -> int`
Operator	`__init__()`	`__init__(self, arg: pyarts3.arts.QuantumLevelIdentifier) -> None`
Operator	`__le__()`	`__le__(self, arg: pyarts3.arts.QuantumLevelIdentifier, /) -> bool`
Operator	`__lt__()`	`__lt__(self, arg: pyarts3.arts.QuantumLevelIdentifier, /) -> bool`
Operator	`__ne__()`	`__ne__(self, arg: pyarts3.arts.QuantumLevelIdentifier, /) -> bool`
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

__init__(self, arg: str, /) → None
__init__(self) → None
__init__(self, arg: QuantumLevelIdentifier) → None

Methods

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

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.
Returns:: artstype – The variable created from the file.
Return type:: QuantumLevelIdentifier

Attributes

isot: SpeciesIsotope: Isotopologue

state: QuantumLevel: State

Operators

__eq__(self, arg: QuantumLevelIdentifier, /) → bool
__eq__(self, arg: QuantumLevelIdentifier, /) → bool

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

__ge__(self, arg: QuantumLevelIdentifier, /) → bool
__ge__(self, arg: QuantumLevelIdentifier, /) → bool

__gt__(self, arg: QuantumLevelIdentifier, /) → bool
__gt__(self, arg: QuantumLevelIdentifier, /) → bool

__hash__(self) → int

__init__(self, arg: str, /) → None
__init__(self) → None
__init__(self, arg: QuantumLevelIdentifier) → None

__le__(self, arg: QuantumLevelIdentifier, /) → bool
__le__(self, arg: QuantumLevelIdentifier, /) → bool

__lt__(self, arg: QuantumLevelIdentifier, /) → bool
__lt__(self, arg: QuantumLevelIdentifier, /) → bool

__ne__(self, arg: QuantumLevelIdentifier, /) → bool
__ne__(self, arg: QuantumLevelIdentifier, /) → bool

__repr__(self) → str

__str__(self) → str