AbsorptionBands
- class pyarts.arts.AbsorptionBands(*args, **kwargs)
A map of
QuantumIdentifier
toAbsorptionBand
Workspace variables of type AbsorptionBands
Overview
Method
Remove all items
Method
Clear the linemixing data from all bands by removing it from the inner line shape models
Method
Return the total number of lines
Method
Returns an iterable view of the map’s items.
Method
Wraps calling percentile_hitran_s followed by remove_hitran_s.
Method
Returns an iterable view of the map’s keys.
Method
Merge the other absorption bands into this
Method
Map of HITRAN linestrengths at a given percentile
Method
Read variable from file
Method
Removes all lines with a weaker HITRAN-like line strength than those provided by the remove map.
Method
Saves variable to file
Method
Update the map with element from arg
Method
Returns an iterable view of the map’s values.
Static Method
Create variable from file
Static Data
pyarts.arts.AbsorptionBands.ItemView
<class ‘pyarts.arts.AbsorptionBands.ItemView’> -
nb_type_0
Static Data
pyarts.arts.AbsorptionBands.KeyView
<class ‘pyarts.arts.AbsorptionBands.KeyView’> -
nb_type_0
Static Data
pyarts.arts.AbsorptionBands.ValueView
<class ‘pyarts.arts.AbsorptionBands.ValueView’> -
nb_type_0
Operator
__contains__(self, arg: object, /) -> bool
Operator
__delitem__(self, arg: pyarts.arts.QuantumIdentifier, /) -> None
Operator
Return self==value.
Operator
Return self>=value.
Operator
__getitem__(self, arg: pyarts.arts.lbl.line_key, /) -> float
Operator
Helper for pickle.
Operator
Return self>value.
Operator
Return hash(self).
Operator
__iter__(self) -> collections.abc.Iterator[pyarts.arts.QuantumIdentifier]
Operator
Return self<=value.
Operator
__len__(self) -> int
Operator
Return self<value.
Operator
Return self!=value.
Operator
__setitem__(self, arg0: pyarts.arts.lbl.line_key, arg1: float, /) -> None
Constructors
- __init__(self) None
- __init__(self, arg: pyarts.arts.AbsorptionBands) None
- __init__(self, arg: dict[pyarts.arts.QuantumIdentifier, pyarts.arts.AbsorptionBand], /) None
- __init__(self) None
- __init__(self, arg: pyarts.arts.AbsorptionBands) None
Overloaded function.
__init__(self) -> None
Default constructor
__init__(self, arg: pyarts.arts.AbsorptionBands) -> None
Copy constructor
__init__(self, arg: dict[pyarts.arts.QuantumIdentifier, pyarts.arts.AbsorptionBand], /) -> None
Construct from a dictionary
__init__(self) -> None
__init__(self, arg: pyarts.arts.AbsorptionBands) -> None
Methods
- clear_linemixing(self) int
Clear the linemixing data from all bands by removing it from the inner line shape models
- Returns:
int
- Return type:
The number of removed variables
- count_lines(self, spec: pyarts.arts.SpeciesEnum = 'AIR') int
Return the total number of lines
- items(self) pyarts.arts.AbsorptionBands.ItemView
Returns an iterable view of the map’s items.
- keep_hitran_s(self, approximate_percentile: float | collections.abc.Mapping[pyarts.arts.SpeciesEnum, float], T0: float = 296.0) None
Wraps calling percentile_hitran_s followed by remove_hitran_s.
- keys(self) pyarts.arts.AbsorptionBands.KeyView
Returns an iterable view of the map’s keys.
- merge(self, other: pyarts.arts.AbsorptionBands) tuple[int, int]
Merge the other absorption bands into this
If the key in the other absorption bands already exists in this, the lines with the same local quantum numbers are overwritten by those of the other absorption bands.
- Parameters:
other (AbsorptionBands) – The other absorption bands to merge into this
- percentile_hitran_s(self, approximate_percentile: float | collections.abc.Mapping[pyarts.arts.SpeciesEnum, float], T0: float = 296.0) dict[pyarts.arts.SpeciesEnum, float]
Map of HITRAN linestrengths at a given percentile
Note
The percentile is approximated by floating point arithmetic on the sorted HITRAN line strenght values.
- readxml(self, file: str) None
Read variable from file
- Parameters:
file (str) – A file that can be read
- On Error:
Throws RuntimeError for any failure to read
- remove_hitran_s(self, remove: collections.abc.Mapping[pyarts.arts.SpeciesEnum, float], T0: float = 296.0) None
Removes all lines with a weaker HITRAN-like line strength than those provided by the remove map.
- savexml(self, file: str, type: str = 'ascii', clobber: bool = True) None
Saves variable to file
- Parameters:
- On Error:
Throws RuntimeError for any failure to save
- update(self, arg: pyarts.arts.AbsorptionBands, /) None
Update the map with element from arg
- values(self) pyarts.arts.AbsorptionBands.ValueView
Returns an iterable view of the map’s values.
Static Methods
- fromxml(file: str) pyarts.arts.AbsorptionBands
Create variable from file
- Parameters:
file (str) – A file that can be read
- On Error:
Throws RuntimeError for any failure to read
Operators
- __contains__(self, arg: pyarts.arts.QuantumIdentifier, /) bool
- __contains__(self, arg: object, /) bool
- __delitem__(self, arg: pyarts.arts.QuantumIdentifier, /) None
- __eq__(value, /)
Return self==value.
- __ge__(value, /)
Return self>=value.
- __getitem__(self, arg: pyarts.arts.QuantumIdentifier, /) pyarts.arts.AbsorptionBand
- __getitem__(self, arg: pyarts.arts.lbl.line_key, /) float
- __getstate__()
Helper for pickle.
- __gt__(value, /)
Return self>value.
- __hash__()
Return hash(self).
- __iter__(self) collections.abc.Iterator[pyarts.arts.QuantumIdentifier]
- __le__(value, /)
Return self<=value.
- __lt__(value, /)
Return self<value.
- __ne__(value, /)
Return self!=value.
- __setitem__(self, arg0: pyarts.arts.QuantumIdentifier, arg1: pyarts.arts.AbsorptionBand, /) None
- __setitem__(self, arg0: pyarts.arts.lbl.line_key, arg1: float, /) None