AbsorptionBands

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

A map of QuantumIdentifier to AbsorptionBand

Workspace variables of type AbsorptionBands

absorption_bands

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	items()	Returns an iterable view of the map’s items.
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	propagation_matrix()	Computes the line-by-line model absorption in 1/m
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	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	<class ‘pyarts3.arts.AbsorptionBands.ItemView’> (nb_type_0)
Static Data	pyarts3.arts.AbsorptionBands.KeyView	<class ‘pyarts3.arts.AbsorptionBands.KeyView’> (nb_type_0)
Static Data	pyarts3.arts.AbsorptionBands.ValueView	<class ‘pyarts3.arts.AbsorptionBands.ValueView’> (nb_type_0)
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	__getstate__()	Helper for pickle.
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: pyarts3.arts.AbsorptionBands) → None

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

__init__(self) → None

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

Overloaded function.

1. __init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from a dictionary

4. __init__(self) -> None

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

int

Return type:

The number of removed variables

count_lines(self, spec: pyarts3.arts.SpeciesEnum = 'AIR') → int

Return the total number of lines

items(self) → pyarts3.arts.AbsorptionBands.ItemView

Returns an iterable view of the map’s items.

keep_hitran_s(self, approximate_percentile: float | collections.abc.Mapping[pyarts3.arts.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) → pyarts3.arts.AbsorptionBands.KeyView

Returns an iterable view of the map’s keys.

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

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.

propagation_matrix(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], ecs_data: pyarts3.arts.LinemixingEcsData = pyarts3.arts.LinemixingEcsData({}), no_negative_absorption: int = 1, **kwargs = {}) → pyarts3.arts.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 (SpeciesEnum, optional) – Species to use. Defaults to all species.

• path_point (PropagationPathPoint, optional) – The path point. Default is POS [0, 0, 0], LOS [0, 0].

• ecs_data (LinemixingEcsData, optional) – The ECS data. Default is empty.

• no_negative_absorption (Index, optional) – If 1, the absorption is set to zero if it is negative. The default is 1.

Returns:

propagation_matrix – Propagation matrix by frequency [1/m]

Return type:

PropmatVector

readxml(self, file: str) → str

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[pyarts3.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.

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) – Type of file to save. See FileType for options.

• clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

update(self, arg: pyarts3.arts.AbsorptionBands, /) → None

Update the map with element from arg

values(self) → pyarts3.arts.AbsorptionBands.ValueView

Returns an iterable view of the map’s values.

Static Methods

fromxml(file: str) → pyarts3.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: pyarts3.arts.QuantumIdentifier, /) → bool

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

__delitem__(self, arg: pyarts3.arts.QuantumIdentifier, /) → None

__eq__(value, /)

Return self==value.

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

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: pyarts3.arts.QuantumIdentifier, /) → pyarts3.arts.AbsorptionBand

__getitem__(self, arg: pyarts3.arts.lbl.line_key, /) → float

__getstate__()

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

1. __init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from a dictionary

4. __init__(self) -> None

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

__iter__(self) → collections.abc.Iterator[pyarts3.arts.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: pyarts3.arts.QuantumIdentifier, arg1: pyarts3.arts.AbsorptionBand, /) → None

__setitem__(self, arg0: pyarts3.arts.lbl.line_key, arg1: float, /) → None

__str__(self) → str