line_key
- class pyarts3.arts.lbl.line_key(*args, **kwargs)
A key for a line
Overview
Method
Read variable from file.
Method
Saves variable to file.
Static Method
Create variable from file.
QuantumIdentifier
The band
The line
LineShapeModelCoefficient
The line shape coefficient
LineShapeModelVariable
The line shape variable
The species
LineByLineVariable
The variable
Operator
__eq__(self, arg: pyarts3.arts.lbl.line_key, /) -> bool
Operator
__format__(self, arg: str, /) -> str
Operator
__ge__(self, arg: pyarts3.arts.lbl.line_key, /) -> bool
Operator
Helper for pickle.
Operator
__gt__(self, arg: pyarts3.arts.lbl.line_key, /) -> bool
Operator
Return hash(self).
Operator
__init__(self, arg: pyarts3.arts.lbl.line_key) -> None
Operator
__le__(self, arg: pyarts3.arts.lbl.line_key, /) -> bool
Operator
__lt__(self, arg: pyarts3.arts.lbl.line_key, /) -> bool
Operator
__ne__(self, arg: pyarts3.arts.lbl.line_key, /) -> bool
Operator
__repr__(self) -> str
Operator
__str__(self) -> str
Constructors
- __init__(self) None
- __init__(self, arg: pyarts3.arts.lbl.line_key) 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:
- 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:
Static Methods
- fromxml(file: str) pyarts3.arts.lbl.line_key
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:
T
Attributes
- band: QuantumIdentifier
The band
- ls_coeff: LineShapeModelCoefficient
The line shape coefficient
- ls_var: LineShapeModelVariable
The line shape variable
- var: LineByLineVariable
The variable
Operators
- __eq__(self, arg: pyarts3.arts.lbl.line_key, /) bool
- __ge__(self, arg: pyarts3.arts.lbl.line_key, /) bool
- __getstate__()
Helper for pickle.
- __gt__(self, arg: pyarts3.arts.lbl.line_key, /) bool
- __hash__()
Return hash(self).
- __init__(self) None
- __init__(self, arg: pyarts3.arts.lbl.line_key) None
- __le__(self, arg: pyarts3.arts.lbl.line_key, /) bool
- __lt__(self, arg: pyarts3.arts.lbl.line_key, /) bool
- __ne__(self, arg: pyarts3.arts.lbl.line_key, /) bool