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_frequencies()`	Keep only the lines within the given frequency range
Method	`keep_hitran_s()`	Keep only the lines with a stronger HITRAN-like line strength
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`LineByLineCutoffType`	`cutoff`	The cutoff type
`Numeric`	`cutoff_value`	The cutoff value [Hz]
`ArrayOfAbsorptionLine`	`lines`	The lines in the band
`LineByLineLineshape`	`lineshape`	The lineshape type
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	`__getstate__()`	Helper for pickle.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.AbsorptionBand) -> None
Operator	`__le__()`	Return self<=value.
Operator	`__len__()`	Return the number of lines in the band
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: 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:: 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) → 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

cutoff_value: Numeric: The cutoff value [Hz]

lines: ArrayOfAbsorptionLine: The lines in the band

lineshape: LineByLineLineshape: The lineshape type

Operators

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

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

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

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

__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.

__len__(self) → int: Return the number of lines in the band

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

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

__repr__(self) → str

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

__str__(self) → str