AbsorptionLines

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

Contains line-by-line absorption information for a number of related absorption lines

Overview

Method

LineShapeOutput()

Computes the line shape paramters for the given atmospheric state

Method

readxml()

Read variable from file

Method

savexml()

Saves variable to file

Static Method

fromxml()

Create variable from file

Attribute

T0

float Reference temperature for all parameters of the lines

Attribute

bathbroadening

bool Does the line broadening have bath broadening?

Attribute

broadeningspecies

ArrayOfSpecies A list of broadening specie

Attribute

cutoff

AbsorptionCutoffTypeOld Cutoff type

Attribute

cutofffreq

float Cutoff frequency

Attribute

linemixinglimit

float Linemixing limit

Attribute

lines

AbsorptionSingleLine A list of individual lines

Attribute

lineshapetype

LineShapeTypeOld Line shape type

Attribute

meta_data

String Catalog meta data string

Attribute

mirroring

AbsorptionMirroringype Mirroring type

Attribute

normalization

AbsorptionNormalizationTypeOld Normalization type

Attribute

ok

bool If False, the catalog cannot be used for any calculations

Attribute

population

AbsorptionPopulationTypeOld Line population distribution

Attribute

quantumidentity

QuantumIdentifier Catalog ID

Attribute

selfbroadening

bool Does the line broadening have self broadening?

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.AbsorptionLines) None
__init__(self, selfbroadening: bool = False, bathbroadening: bool = False, cutoff: pyarts.arts.AbsorptionCutoffTypeOld = 'None', mirroring: pyarts.arts.AbsorptionMirroringTypeOld = 'None', population: pyarts.arts.AbsorptionPopulationTypeOld = 'LTE', normalization: pyarts.arts.AbsorptionNormalizationTypeOld = 'None', lineshapetype: pyarts.arts.LineShapeTypeOld = 'DP', T0: float = 296, cutofffreq: float = -1, linemixinglimit: float = -1, quantumidentity: pyarts.arts.QuantumIdentifier = 'H2O-161 ', broadeningspecies: pyarts.arts.ArrayOfSpeciesEnum = pyarts.arts.ArrayOfSpeciesEnum([]), lines: pyarts.arts.ArrayOfAbsorptionSingleLine = pyarts.arts.ArrayOfAbsorptionSingleLine([])) None

Overloaded function.

  1. __init__(self) -> None

  2. __init__(self, arg: pyarts.arts.AbsorptionLines) -> None

  3. __init__(self, selfbroadening: bool = False, bathbroadening: bool = False, cutoff: pyarts.arts.AbsorptionCutoffTypeOld = "None", mirroring: pyarts.arts.AbsorptionMirroringTypeOld = "None", population: pyarts.arts.AbsorptionPopulationTypeOld = "LTE", normalization: pyarts.arts.AbsorptionNormalizationTypeOld = "None", lineshapetype: pyarts.arts.LineShapeTypeOld = "DP", T0: float = 296, cutofffreq: float = -1, linemixinglimit: float = -1, quantumidentity: pyarts.arts.QuantumIdentifier = "H2O-161 ", broadeningspecies: pyarts.arts.ArrayOfSpeciesEnum = pyarts.arts.ArrayOfSpeciesEnum([]), lines: pyarts.arts.ArrayOfAbsorptionSingleLine = pyarts.arts.ArrayOfAbsorptionSingleLine([])) -> None

From values

Methods

LineShapeOutput(self, line: int, T: float, P: float, VMR: pyarts.arts.Vector) pyarts.arts.LineShapeOutput

Computes the line shape paramters for the given atmospheric state

Note that the normalization assumes sum(VMR) is 1 for good results but does not enforce it

Parameters:
  • line (int) – Line index

  • T (float) – Temperature

  • P (float) – Pressure

  • VMR (Vector) – List of VMR values, must match length of broadening species

Returns:

X – The computed line shape parameters

Return type:

LineShapeOutput

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

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

T0

float Reference temperature for all parameters of the lines

bathbroadening

bool Does the line broadening have bath broadening?

broadeningspecies

ArrayOfSpecies A list of broadening specie

cutoff

AbsorptionCutoffTypeOld Cutoff type

cutofffreq

float Cutoff frequency

linemixinglimit

float Linemixing limit

lines

AbsorptionSingleLine A list of individual lines

lineshapetype

LineShapeTypeOld Line shape type

meta_data

String Catalog meta data string

mirroring

AbsorptionMirroringype Mirroring type

normalization

AbsorptionNormalizationTypeOld Normalization type

ok

bool If False, the catalog cannot be used for any calculations

population

AbsorptionPopulationTypeOld Line population distribution

quantumidentity

QuantumIdentifier Catalog ID

selfbroadening

bool Does the line broadening have self broadening?

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.