AbsorptionBand
- class pyarts3.arts.AbsorptionBand(*args, **kwargs)
Contains information about a band of related absorption lines.
This information includes
A list of
AbsorptionLine
.The line shape profile model. See
LineByLineLineshape
for available line shape profiles.The frequency cutoff value in [Hz] and type. See
LineByLineCutoffType
for available cutoff types.
Note
This type does not know about the species that the absorption band/lines belongs to. This is why it is often required to keep the
AbsorptionBands
object around.Overview
Method
Keep only the lines within the given frequency range
Method
Keep only the lines with a stronger HITRAN-like line strength
Method
Read variable from file.
Method
Saves variable to file.
Static Method
Create variable from file.
The cutoff type
The cutoff value [Hz]
The lines in the band
The lineshape type
Operator
Return self==value.
Operator
__format__(self, arg: str, /) -> str
Operator
Return self>=value.
Operator
Helper for pickle.
Operator
Return self>value.
Operator
Return hash(self).
Operator
__init__(self, arg: pyarts3.arts.AbsorptionBand) -> None
Operator
Return self<=value.
Operator
Return self<value.
Operator
Return self!=value.
Operator
__repr__(self) -> str
Operator
__str__(self) -> str
Constructors
- __init__(self) None
- __init__(self, arg: pyarts3.arts.AbsorptionBand) None
Methods
- keep_frequencies(self, freqs: pyarts3.arts.Vector2) None
Keep only the lines within the given frequency range
- keep_hitran_s(self, min_s: float, isot: pyarts3.arts.SpeciesIsotope, T0: float = 296.0) None
Keep only the lines with a stronger HITRAN-like line strength
- 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.AbsorptionBand
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
- cutoff: LineByLineCutoffType
The cutoff type
- lines: ArrayOfAbsorptionLine
The lines in the band
- lineshape: LineByLineLineshape
The lineshape type
Operators
- __eq__(value, /)
Return self==value.
- __ge__(value, /)
Return self>=value.
- __getstate__()
Helper for pickle.
- __gt__(value, /)
Return self>value.
- __hash__()
Return hash(self).
- __init__(self) None
- __init__(self, arg: pyarts3.arts.AbsorptionBand) None
- __le__(value, /)
Return self<=value.
- __lt__(value, /)
Return self<value.
- __ne__(value, /)
Return self!=value.