ARTS  2.4.0(git:4fb77825)
absorptionlines.h File Reference

Contains the absorption namespace. More...

#include <vector>
#include "bifstream.h"
#include "bofstream.h"
#include "lineshapemodel.h"
#include "matpack.h"
#include "quantum.h"
#include "zeemandata.h"

Go to the source code of this file.

Classes

class  Absorption::SingleLine
 Computations and data for a single absorption line. More...
 
struct  Absorption::SingleLineExternal
 Single line reading output. More...
 
class  Absorption::Lines
 

Namespaces

 Absorption
 Namespace to contain things required for absorption calculations.
 

Typedefs

typedef Absorption::SingleLine AbsorptionSingleLine
 
typedef Absorption::Lines AbsorptionLines
 
typedef Array< AbsorptionLinesArrayOfAbsorptionLines
 
typedef Array< ArrayOfAbsorptionLinesArrayOfArrayOfAbsorptionLines
 

Enumerations

enum  Absorption::MirroringType : Index { Absorption::MirroringType::None, Absorption::MirroringType::Lorentz, Absorption::MirroringType::SameAsLineShape, Absorption::MirroringType::Manual }
 Describes the type of mirroring line effects. More...
 
enum  Absorption::NormalizationType : Index { Absorption::NormalizationType::None, Absorption::NormalizationType::VVH, Absorption::NormalizationType::VVW, Absorption::NormalizationType::RosenkranzQuadratic }
 Describes the type of normalization line effects. More...
 
enum  Absorption::PopulationType : Index {
  Absorption::PopulationType::ByLTE, Absorption::PopulationType::ByNLTEVibrationalTemperatures, Absorption::PopulationType::ByNLTEPopulationDistribution, Absorption::PopulationType::ByHITRANRosenkranzRelmat,
  Absorption::PopulationType::ByHITRANFullRelmat
}
 Describes the type of population level counter. More...
 
enum  Absorption::CutoffType : Index { Absorption::CutoffType::None, Absorption::CutoffType::LineByLineOffset, Absorption::CutoffType::BandFixedFrequency }
 Describes the type of cutoff calculations. More...
 

Functions

MirroringType Absorption::string2mirroringtype (const String &in)
 
String Absorption::mirroringtype2string (MirroringType in)
 
String Absorption::mirroringtype2metadatastring (MirroringType in)
 
NormalizationType Absorption::string2normalizationtype (const String &in)
 
String Absorption::normalizationtype2string (NormalizationType in)
 
String Absorption::normalizationtype2metadatastring (NormalizationType in)
 
PopulationType Absorption::string2populationtype (const String &in)
 
String Absorption::populationtype2string (PopulationType in)
 
String Absorption::populationtype2metadatastring (PopulationType in)
 
bool Absorption::relaxationtype_relmat (PopulationType in)
 
CutoffType Absorption::string2cutofftype (const String &in)
 
String Absorption::cutofftype2string (CutoffType in)
 
String Absorption::cutofftype2metadatastring (CutoffType in, Numeric cutoff)
 
std::ostream & Absorption::operator<< (std::ostream &, const SingleLine &)
 
std::istream & Absorption::operator>> (std::istream &, SingleLine &)
 
std::ostream & Absorption::operator<< (std::ostream &, const Lines &)
 
std::istream & Absorption::operator>> (std::istream &, Lines &)
 
SingleLineExternal Absorption::ReadFromArtscat3Stream (istream &is)
 Read from ARTSCAT-3. More...
 
SingleLineExternal Absorption::ReadFromArtscat4Stream (istream &is)
 Read from ARTSCAT-4. More...
 
SingleLineExternal Absorption::ReadFromArtscat5Stream (istream &is)
 Read from ARTSCAT-5. More...
 
SingleLineExternal Absorption::ReadFromLBLRTMStream (istream &is)
 Read from LBLRTM. More...
 
SingleLineExternal Absorption::ReadFromHitran2004Stream (istream &is)
 Read from newer HITRAN. More...
 
SingleLineExternal Absorption::ReadFromHitranOnlineStream (istream &is)
 Read from HITRAN online. More...
 
SingleLineExternal Absorption::ReadFromHitran2001Stream (istream &is)
 Read from HITRAN before 2004. More...
 
SingleLineExternal Absorption::ReadFromMytran2Stream (istream &is)
 Read from Mytran2 The MYTRAN2 format is as follows (directly taken from the abs_my.c documentation): More...
 
SingleLineExternal Absorption::ReadFromJplStream (istream &is)
 Read from JPL. More...
 
std::vector< Lines > Absorption::split_list_of_external_lines (std::vector< SingleLineExternal > &external_lines, const std::vector< QuantumNumberType > &localquantas={}, const std::vector< QuantumNumberType > &globalquantas={})
 Splits a list of lines into proper Lines. More...
 
Lines Absorption::createEmptyCopy (const Lines &al) noexcept
 Creates a copy of the input lines structure. More...
 
bool Absorption::line_in_id (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier match a line's ID. More...
 
bool Absorption::line_is_id (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier is equal to a line's identifier. More...
 
bool Absorption::id_in_line (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier match a line's ID. More...
 
bool Absorption::line_upper_in_id (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier match a line's ID. More...
 
bool Absorption::line_lower_in_id (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier match a line's ID. More...
 
bool Absorption::id_in_line_upper (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier match a line's ID. More...
 
bool Absorption::id_in_line_lower (const Lines &band, const QuantumIdentifier &id, size_t line_index)
 Checks if the external quantum identifier match a line's ID. More...
 
Index Absorption::nelem (const Lines &l)
 Number of lines. More...
 
Index Absorption::nelem (const Array< Lines > &l)
 Number of lines in list. More...
 
Index Absorption::nelem (const Array< Array< Lines >> &l)
 Number of lines in lists. More...
 
Numeric Absorption::reduced_rovibrational_dipole (Rational Jf, Rational Ji, Rational lf, Rational li, Rational k=Rational(1))
 Compute the reduced rovibrational dipole moment. More...
 
Numeric Absorption::reduced_magnetic_quadrapole (Rational Jf, Rational Ji, Rational N)
 Compute the reduced magnetic quadrapole moment. More...
 
std::ostream & operator<< (std::ostream &, const ArrayOfAbsorptionLines &)
 
std::ostream & operator<< (std::ostream &, const ArrayOfArrayOfAbsorptionLines &)
 

Detailed Description

Contains the absorption namespace.

Author
Richard Larsson
Date
2019-09-07

Contains the absorption lines implementation

This namespace contains classes to deal with absorption lines

Definition in file absorptionlines.h.

Typedef Documentation

◆ AbsorptionLines

Definition at line 1850 of file absorptionlines.h.

◆ AbsorptionSingleLine

◆ ArrayOfAbsorptionLines

Definition at line 1851 of file absorptionlines.h.

◆ ArrayOfArrayOfAbsorptionLines

Function Documentation

◆ operator<<() [1/2]

std::ostream& operator<< ( std::ostream &  ,
const ArrayOfAbsorptionLines  
)

Definition at line 2533 of file absorptionlines.cc.

◆ operator<<() [2/2]

std::ostream& operator<< ( std::ostream &  ,
const ArrayOfArrayOfAbsorptionLines  
)

Definition at line 2540 of file absorptionlines.cc.