AbsorptionBand

class pyarts.arts.AbsorptionBand(*args, **kwargs)

Contains all information about bands of related absorption lines

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

Attribute

cutoff

The cutoff type

Attribute

cutoff_value

The cutoff value [Hz]

Attribute

lines

The lines in the band

Attribute

lineshape

The lineshape type

Operator

__eq__()

Return self==value.

Operator

__ge__()

Return self>=value.

Operator

__gt__()

Return self>value.

Operator

__hash__()

Return hash(self).

Operator

__le__()

Return self<=value.

Operator

__lt__()

Return self<value.

Operator

__ne__()

Return self!=value.

Constructors

__init__(self) None
__init__(self, arg: pyarts.arts.AbsorptionBand) None

Methods

keep_frequencies(self, freqs: pyarts.arts.Vector2) None

Keep only the lines within the given frequency range

keep_hitran_s(self, min_s: float, isot: pyarts.arts.SpeciesIsotope, T0: float = 296.0) None

Keep only the lines with a stronger HITRAN-like line strength

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

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) None

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

Static Methods

fromxml(file: str) pyarts.arts.AbsorptionBand

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

cutoff

The cutoff type

cutoff_value

The cutoff value [Hz]

lines

The lines in the band

lineshape

The lineshape type

Operators

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.