AbsorptionBands

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

A map of QuantumIdentifier to AbsorptionBand

Overview

Method	`clear()`	Remove all items
Method	`clear_linemixing()`	Clear the linemixing data from all bands by removing it from the inner line shape models
Method	`count_lines()`	Return the total number of lines
Method	`extendxml()`	Extend variable from file.
Method	`extract_species()`	Extract absorption bands for a given species or isotope.
Method	`items()`	Returns an iterable view of the map’s items.
Method	`keep_frequencies()`	Keep the frequencies within the specified range
Method	`keep_hitran_s()`	Wraps calling percentile_hitran_s followed by remove_hitran_s.
Method	`keys()`	Returns an iterable view of the map’s keys.
Method	`merge()`	Merge the other absorption bands into this
Method	`percentile_hitran_s()`	Map of HITRAN linestrengths at a given percentile
Method	`readxml()`	Read variable from file.
Method	`remove_hitran_s()`	Removes all lines with a weaker HITRAN-like line strength than those provided by the remove map.
Method	`savexml()`	Saves variable to file.
Method	`spectral_propmat()`	Computes the line-by-line model absorption in 1/m
Method	`update()`	Update the map with element from arg
Method	`values()`	Returns an iterable view of the map’s values.
Static Method	`fromxml()`	Create variable from file.
Static Data	`pyarts3.arts.AbsorptionBands.ItemView`	`ItemView`
Static Data	`pyarts3.arts.AbsorptionBands.KeyView`	`KeyView`
Static Data	`pyarts3.arts.AbsorptionBands.ValueView`	`ValueView`
Operator	`__contains__()`	`__contains__(self, arg: object, /) -> bool`
Operator	`__delitem__()`	`__delitem__(self, arg: pyarts3.arts.QuantumIdentifier, /) -> None`
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	Return self>=value.
Operator	`__getitem__()`	`__getitem__(self, arg: pyarts3.arts.lbl.line_key, /) -> float`
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__iter__()`	`__iter__(self) -> collections.abc.Iterator[pyarts3.arts.QuantumIdentifier]`
Operator	`__le__()`	Return self<=value.
Operator	`__len__()`	`__len__(self) -> int`
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__setitem__()`	`__setitem__(self, arg0: pyarts3.arts.lbl.line_key, arg1: float, /) -> None`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

__init__(self) → None

__init__(self, arg: AbsorptionBands) → None

__init__(self, arg: dict[QuantumIdentifier, AbsorptionBand], /) → None

__init__(self) → None

__init__(self, arg: AbsorptionBands) → None

Overloaded function.

__init__(self) -> None

Default constructor

__init__(self, arg: pyarts3.arts.AbsorptionBands) -> None

Copy constructor

__init__(self, arg: dict[pyarts3.arts.QuantumIdentifier, pyarts3.arts.AbsorptionBand], /) -> None

Construct from a dictionary

__init__(self) -> None
__init__(self, arg: pyarts3.arts.AbsorptionBands) -> None

Methods

clear(self) → None: Remove all items

clear_linemixing(self) → int

Clear the linemixing data from all bands by removing it from the inner line shape models

Returns:: count – The number of removed variables.
Return type:: int

count_lines(self, spec: SpeciesEnum = 'AIR') → int: Return the total number of lines

extendxml(self, file: str) → str

Extend variable from file.

The content of the file is added to the existing variable.

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

extract_species(self, spec: SpeciesEnum | SpeciesIsotope) → AbsorptionBands

Extract absorption bands for a given species or isotope.

Parameters:: vkey (SpeciesEnum or SpeciesIsotope) – The species or isotope to extract
Returns:: The extracted absorption bands
Return type:: AbsorptionBands

items(self) → ItemView: Returns an iterable view of the map’s items.

keep_frequencies(self, fmin: float = -inf, fmax: float = inf) → None

Keep the frequencies within the specified range

Parameters:

fmin (Numeric) – Minimum frequency
fmax (Numeric) – Maximum frequency

keep_hitran_s(self, approximate_percentile: float | Mapping[SpeciesEnum, float], T0: float = 296.0) → None

Wraps calling percentile_hitran_s followed by remove_hitran_s.

Parameters:

percentile (float or dict) – See percentile_hitran_s.
T0 (float) – The reference temperature. Defaults to 296.0.

keys(self) → KeyView: Returns an iterable view of the map’s keys.

merge(self, other: 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 | Mapping[SpeciesEnum, float], T0: float = 296.0) → dict[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.

Parameters:

percentile (float or dict) – The percentile to keep. If a float, the same percentile is used for all species. If a dict, the species are mapped to their respective percentiles. Values must be [0, 100].
T0 (float) – The reference temperature. Defaults to 296.0.

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

remove_hitran_s(self, remove: Mapping[SpeciesEnum, float], T0: float = 296.0) → None

Removes all lines with a weaker HITRAN-like line strength than those provided by the remove map.

Parameters:

remove (dict) – The species to keep with their respective minimum HITRAN-like line strengths
T0 (float) – The reference temperature. Defaults to 296.0.

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

spectral_propmat(self, f: pyarts3.arts.AscendingGrid, atm: pyarts3.arts.AtmPoint, spec: pyarts3.arts.SpeciesEnum = "AIR", path_point: pyarts3.arts.PropagationPathPoint = [unknown, unknown, 0, 0, 0, 0, 0, 1, 1], abs_ecs_data: pyarts3.arts.LinemixingEcsData = pyarts3.arts.LinemixingEcsData({}), no_negative_absorption: int = 1, **kwargs = {}) → PropmatVector

Computes the line-by-line model absorption in 1/m

The method accepts any number of kwargs to be compatible with similar methods for computing the propagation matrix.

Parameters:

f (AscendingGrid) – Frequency grid [Hz]
atm (AtmPoint) – Atmospheric point
spec (~pyarts3.arts.SpeciesEnum, optional) – Species to use. Defaults to all species.
path_point (~pyarts3.arts.PropagationPathPoint, optional) – The path point. Default is POS [0, 0, 0], LOS [0, 0].
abs_ecs_data (~pyarts3.arts.LinemixingEcsData, optional) – The ECS data. Default is empty.
no_negative_absorption (~pyarts3.arts.Index, optional) – If 1, the absorption is set to zero if it is negative. The default is 1.

Returns:

spectral_propmat – Propagation matrix by frequency [1/m]

Return type:

PropmatVector

update(self, arg: AbsorptionBands, /) → None: Update the map with element from arg

values(self) → ValueView: Returns an iterable view of the map’s values.

Static Methods

fromxml(file: str) → AbsorptionBands

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:: AbsorptionBands

Operators

__contains__(self, arg: QuantumIdentifier, /) → bool
__contains__(self, arg: object, /) → bool

__delitem__(self, arg: QuantumIdentifier, /) → None

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

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

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

__getitem__(self, arg: QuantumIdentifier, /) → AbsorptionBand
__getitem__(self, arg: line_key, /) → float

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__init__(self) → None

__init__(self, arg: AbsorptionBands) → None

__init__(self, arg: dict[QuantumIdentifier, AbsorptionBand], /) → None

__init__(self) → None

__init__(self, arg: AbsorptionBands) → None

Overloaded function.

__init__(self) -> None

Default constructor

__init__(self, arg: pyarts3.arts.AbsorptionBands) -> None

Copy constructor

__init__(self, arg: dict[pyarts3.arts.QuantumIdentifier, pyarts3.arts.AbsorptionBand], /) -> None

Construct from a dictionary

__init__(self) -> None
__init__(self, arg: pyarts3.arts.AbsorptionBands) -> None

__iter__(self) → Iterator[QuantumIdentifier]

__le__(value, /): Return self<=value.

__len__(self) → int

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

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

__repr__(self) → str
__repr__(self) → str

__setitem__(self, arg0: QuantumIdentifier, arg1: AbsorptionBand, /) → None
__setitem__(self, arg0: line_key, arg1: float, /) → None

__str__(self) → str

class pyarts3.arts.AbsorptionBands.ItemView

class pyarts3.arts.AbsorptionBands.KeyView

class pyarts3.arts.AbsorptionBands.ValueView