ARTS  2.3.1285(git:92a29ea9-dirty)
m_absorptionlines.cc File Reference

Contains the absorption namespace. More...

#include "absorptionlines.h"
#include "auto_md.h"
#include "file.h"
#include "global_data.h"
#include "xml_io_private.h"
#include "m_xml.h"

Go to the source code of this file.

Enumerations

enum  HitranType { HitranType::Pre2004, HitranType::Post2004, HitranType::Online }
 

Functions

std::vector< QuantumNumberTypestring2vecqn (const String &qnstr)
 Get a list of quantum numbers from a string. More...
 
void ReadArrayOfARTSCAT (ArrayOfAbsorptionLines &abs_lines, const String &artscat_file, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadArrayOfARTSCAT. More...
 
void ReadARTSCAT (ArrayOfAbsorptionLines &abs_lines, const String &artscat_file, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadARTSCAT. More...
 
void ReadSplitARTSCAT (ArrayOfAbsorptionLines &abs_lines, const ArrayOfArrayOfSpeciesTag &abs_species, const String &basename, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const Index &ignore_missing, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadSplitARTSCAT. More...
 
HitranType string2hitrantype (const String &s)
 
void ReadHITRAN (ArrayOfAbsorptionLines &abs_lines, const String &hitran_file, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const String &hitran_type, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadHITRAN. More...
 
void ReadLBLRTM (ArrayOfAbsorptionLines &abs_lines, const String &lblrtm_file, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadLBLRTM. More...
 
void ReadMytran2 (ArrayOfAbsorptionLines &abs_lines, const String &mytran2_file, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadMytran2. More...
 
void ReadJPL (ArrayOfAbsorptionLines &abs_lines, const String &jpl_file, const Numeric &fmin, const Numeric &fmax, const String &globalquantumnumbers, const String &localquantumnumbers, const String &normalization_option, const String &mirroring_option, const String &population_option, const String &lineshapetype_option, const String &cutoff_option, const Numeric &cutoff_value, const Numeric &linemixinglimit_value, const Verbosity &verbosity)
 WORKSPACE METHOD: ReadJPL. More...
 
void abs_linesWriteSplitXML (const String &output_format, const ArrayOfAbsorptionLines &abs_lines, const String &basename, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesWriteSplitXML. More...
 
void abs_linesWriteSpeciesSplitXML (const String &output_format, const ArrayOfAbsorptionLines &abs_lines, const String &basename, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesWriteSpeciesSplitXML. More...
 
void abs_lines_per_speciesWriteSplitXML (const String &output_format, const ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &basename, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesWriteSplitXML. More...
 
void abs_lines_per_speciesWriteSpeciesSplitXML (const String &output_format, const ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &basename, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesWriteSpeciesSplitXML. More...
 
void abs_lines_per_speciesReadSplitCatalog (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &basename, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesReadSplitCatalog. More...
 
void abs_linesReadSpeciesSplitCatalog (ArrayOfAbsorptionLines &abs_lines, const String &basename, const Index &robust, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesReadSpeciesSplitCatalog. More...
 
void abs_lines_per_speciesReadSpeciesSplitCatalog (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &basename, const Index &robust, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesReadSpeciesSplitCatalog. More...
 
void abs_linesSetQuantumNumberForMatch (ArrayOfAbsorptionLines &abs_lines, const String &qn, const Rational &x, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetQuantumNumberForMatch. More...
 
void abs_lines_per_speciesSetQuantumNumberForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &qn, const Rational &x, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetQuantumNumberForMatch. More...
 
void abs_linesTruncateGlobalQuantumNumbers (ArrayOfAbsorptionLines &abs_lines, const Verbosity &)
 WORKSPACE METHOD: abs_linesTruncateGlobalQuantumNumbers. More...
 
void abs_linesRemoveUnusedLocalQuantumNumbers (ArrayOfAbsorptionLines &abs_lines, const Verbosity &)
 WORKSPACE METHOD: abs_linesRemoveUnusedLocalQuantumNumbers. More...
 
void abs_linesReplaceWithLines (ArrayOfAbsorptionLines &abs_lines, const ArrayOfAbsorptionLines &replacing_lines, const Verbosity &)
 WORKSPACE METHOD: abs_linesReplaceWithLines. More...
 
void abs_linesAppendWithLines (ArrayOfAbsorptionLines &abs_lines, const ArrayOfAbsorptionLines &appending_lines, const Index &safe, const Verbosity &)
 WORKSPACE METHOD: abs_linesAppendWithLines. More...
 
void abs_linesDeleteBadF0 (ArrayOfAbsorptionLines &abs_lines, const Numeric &f0, const Index &lower, const Verbosity &)
 WORKSPACE METHOD: abs_linesDeleteBadF0. More...
 
void abs_linesDeleteWithLines (ArrayOfAbsorptionLines &abs_lines, const ArrayOfAbsorptionLines &deleting_lines, const Verbosity &)
 WORKSPACE METHOD: abs_linesDeleteWithLines. More...
 
void abs_linesDeleteLinesWithUndefinedLocalQuanta (ArrayOfAbsorptionLines &abs_lines, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesDeleteLinesWithUndefinedLocalQuanta. More...
 
void abs_linesDeleteLinesWithBadOrHighChangingJs (ArrayOfAbsorptionLines &abs_lines, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesDeleteLinesWithBadOrHighChangingJs. More...
 
void abs_linesDeleteLinesWithQuantumNumberAbove (ArrayOfAbsorptionLines &abs_lines, const String &qn_id, const Index &qn_val, const Verbosity &)
 WORKSPACE METHOD: abs_linesDeleteLinesWithQuantumNumberAbove. More...
 
void abs_linesSetEmptyBroadeningParametersToEmpty (ArrayOfAbsorptionLines &abs_lines, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetEmptyBroadeningParametersToEmpty. More...
 
void abs_linesKeepBands (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &qid, const Index &ignore_spec, const Index &ignore_isot, const Verbosity &)
 WORKSPACE METHOD: abs_linesKeepBands. More...
 
void abs_linesCleanupEmpty (ArrayOfAbsorptionLines &abs_lines, const Verbosity &)
 WORKSPACE METHOD: abs_linesCleanupEmpty. More...
 
void abs_linesSetCutoff (ArrayOfAbsorptionLines &abs_lines, const String &type, const Numeric &x, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetCutoff. More...
 
void abs_lines_per_speciesSetCutoff (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const Numeric &x, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetCutoff. More...
 
void abs_linesSetCutoffForMatch (ArrayOfAbsorptionLines &abs_lines, const String &type, const Numeric &x, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetCutoffForMatch. More...
 
void abs_lines_per_speciesSetCutoffForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const Numeric &x, const QuantumIdentifier &QI, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetCutoffForMatch. More...
 
void abs_lines_per_speciesSetCutoffForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &type, const Numeric &x, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetCutoffForSpecies. More...
 
void abs_linesSetMirroring (ArrayOfAbsorptionLines &abs_lines, const String &type, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetMirroring. More...
 
void abs_lines_per_speciesSetMirroring (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetMirroring. More...
 
void abs_linesSetMirroringForMatch (ArrayOfAbsorptionLines &abs_lines, const String &type, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetMirroringForMatch. More...
 
void abs_lines_per_speciesSetMirroringForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetMirroringForMatch. More...
 
void abs_lines_per_speciesSetMirroringForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &type, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetMirroringForSpecies. More...
 
void abs_linesSetPopulation (ArrayOfAbsorptionLines &abs_lines, const String &type, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetPopulation. More...
 
void abs_lines_per_speciesSetPopulation (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetPopulation. More...
 
void abs_linesSetPopulationForMatch (ArrayOfAbsorptionLines &abs_lines, const String &type, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetPopulationForMatch. More...
 
void abs_lines_per_speciesSetPopulationForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetPopulationForMatch. More...
 
void abs_lines_per_speciesSetPopulationForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &type, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetPopulationForSpecies. More...
 
void abs_linesSetNormalization (ArrayOfAbsorptionLines &abs_lines, const String &type, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetNormalization. More...
 
void abs_lines_per_speciesSetNormalization (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetNormalization. More...
 
void abs_linesSetNormalizationForMatch (ArrayOfAbsorptionLines &abs_lines, const String &type, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetNormalizationForMatch. More...
 
void abs_lines_per_speciesSetNormalizationForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetNormalizationForMatch. More...
 
void abs_lines_per_speciesSetNormalizationForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &type, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetNormalizationForSpecies. More...
 
void abs_linesSetLineShapeType (ArrayOfAbsorptionLines &abs_lines, const String &type, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetLineShapeType. More...
 
void abs_lines_per_speciesSetLineShapeType (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeType. More...
 
void abs_linesSetLineShapeTypeForMatch (ArrayOfAbsorptionLines &abs_lines, const String &type, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetLineShapeTypeForMatch. More...
 
void abs_lines_per_speciesSetLineShapeTypeForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const String &type, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeTypeForMatch. More...
 
void abs_lines_per_speciesSetLineShapeTypeForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const String &type, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeTypeForSpecies. More...
 
void abs_linesSetLinemixingLimit (ArrayOfAbsorptionLines &abs_lines, const Numeric &x, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetLinemixingLimit. More...
 
void abs_lines_per_speciesSetLinemixingLimit (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Numeric &x, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetLinemixingLimit. More...
 
void abs_linesSetLinemixingLimitForMatch (ArrayOfAbsorptionLines &abs_lines, const Numeric &x, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetLinemixingLimitForMatch. More...
 
void abs_lines_per_speciesSetLinemixingLimitForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Numeric &x, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetLinemixingLimitForMatch. More...
 
void abs_lines_per_speciesSetLinemixingLimitForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const Numeric &x, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetLinemixingLimitForSpecies. More...
 
void abs_linesSetT0 (ArrayOfAbsorptionLines &abs_lines, const Numeric &x, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetT0. More...
 
void abs_lines_per_speciesSetT0 (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Numeric &x, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetT0. More...
 
void abs_linesSetT0ForMatch (ArrayOfAbsorptionLines &abs_lines, const Numeric &x, const QuantumIdentifier &QI, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetT0ForMatch. More...
 
void abs_lines_per_speciesSetT0ForMatch (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Numeric &x, const QuantumIdentifier &QI, const Verbosity &v)
 WORKSPACE METHOD: abs_lines_per_speciesSetT0ForMatch. More...
 
void abs_lines_per_speciesSetT0ForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const Numeric &x, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetT0ForSpecies. More...
 
void abs_linesChangeBaseParameterForMatchingLines (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &relative, const Index &loose_matching, const Verbosity &)
 WORKSPACE METHOD: abs_linesChangeBaseParameterForMatchingLines. More...
 
void abs_lines_per_speciesChangeBaseParameterForMatchingLines (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &relative, const Index &loose_matching, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForMatchingLines. More...
 
void abs_lines_per_speciesChangeBaseParameterForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &relative, const Index &loose_matching, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForSpecies. More...
 
void abs_linesSetBaseParameterForMatchingLines (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &x, const Index &loose_matching, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetBaseParameterForMatchingLines. More...
 
void abs_lines_per_speciesSetBaseParameterForMatchingLines (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &loose_matching, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForMatchingLines. More...
 
void abs_lines_per_speciesSetBaseParameterForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &loose_matching, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForSpecies. More...
 
void abs_linesChangeLineShapeModelParameterForMatchingLines (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &QI, const String &parameter, const String &coefficient, const String &species, const Numeric &x, const Index &relative, const Verbosity &)
 WORKSPACE METHOD: abs_linesChangeLineShapeModelParameterForMatchingLines. More...
 
void abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const QuantumIdentifier &QI, const String &parameter, const String &coefficient, const String &species, const Numeric &x, const Index &relative, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines. More...
 
void abs_lines_per_speciesChangeLineShapeModelParameterForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const QuantumIdentifier &QI, const String &parameter, const String &coefficient, const String &species, const Numeric &x, const Index &relative, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesChangeLineShapeModelParameterForSpecies. More...
 
void abs_linesSetLineShapeModelParameterForMatchingLines (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &QI, const String &parameter, const String &coefficient, const String &species, const Numeric &new_value, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetLineShapeModelParameterForMatchingLines. More...
 
void abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const QuantumIdentifier &QI, const String &parameter, const String &coefficient, const String &species, const Numeric &new_value, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines. More...
 
void abs_lines_per_speciesSetLineShapeModelParameterForSpecies (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const QuantumIdentifier &QI, const String &parameter, const String &coefficient, const String &species, const Numeric &new_value, const String &species_tag, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeModelParameterForSpecies. More...
 
void abs_linesChangeBaseParameterForMatchingLevel (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &relative, const Verbosity &)
 WORKSPACE METHOD: abs_linesChangeBaseParameterForMatchingLevel. More...
 
void abs_lines_per_speciesChangeBaseParameterForMatchingLevel (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Index &relative, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForMatchingLevel. More...
 
void abs_linesChangeBaseParameterForMatchingLevels (ArrayOfAbsorptionLines &abs_lines, const ArrayOfQuantumIdentifier &QID, const String &parameter_name, const Vector &change, const Index &relative, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesChangeBaseParameterForMatchingLevels. More...
 
void abs_lines_per_speciesChangeBaseParameterForMatchingLevels (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfQuantumIdentifier &QID, const String &parameter_name, const Vector &change, const Index &relative, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForMatchingLevels. More...
 
void abs_linesSetBaseParameterForMatchingLevel (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &x, const Verbosity &)
 WORKSPACE METHOD: abs_linesSetBaseParameterForMatchingLevel. More...
 
void abs_lines_per_speciesSetBaseParameterForMatchingLevel (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const QuantumIdentifier &QI, const String &parameter_name, const Numeric &change, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForMatchingLevel. More...
 
void abs_linesSetBaseParameterForMatchingLevels (ArrayOfAbsorptionLines &abs_lines, const ArrayOfQuantumIdentifier &QID, const String &parameter_name, const Vector &change, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesSetBaseParameterForMatchingLevels. More...
 
void abs_lines_per_speciesSetBaseParameterForMatchingLevels (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfQuantumIdentifier &QID, const String &parameter_name, const Vector &change, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForMatchingLevels. More...
 
void nlteSetByQuantumIdentifiers (Index &nlte_do, ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const EnergyLevelMap &nlte_field, const Verbosity &)
 WORKSPACE METHOD: nlteSetByQuantumIdentifiers. More...
 
void abs_lines_per_speciesSetEmpty (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const ArrayOfArrayOfSpeciesTag &abs_species, const Verbosity &)
 WORKSPACE METHOD: abs_lines_per_speciesSetEmpty. More...
 
void abs_linesCompact (ArrayOfAbsorptionLines &abs_lines, const Vector &f_grid, const Verbosity &)
 WORKSPACE METHOD: abs_linesCompact. More...
 
void abs_lines_per_speciesCompact (ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Vector &f_grid, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_lines_per_speciesCompact. More...
 
void abs_linesRemoveBand (ArrayOfAbsorptionLines &abs_lines, const QuantumIdentifier &qid, const Verbosity &)
 WORKSPACE METHOD: abs_linesRemoveBand. More...
 
template<class T >
std::vector< T > linspace (T s, T e, typename std::vector< T >::size_type count) noexcept
 
void f_gridFromAbsorptionLines (Vector &f_grid, const ArrayOfArrayOfAbsorptionLines &abs_lines_per_species, const Numeric &delta_f_low, const Numeric &delta_f_upp, const Index &num_freqs, const Verbosity &)
 WORKSPACE METHOD: f_gridFromAbsorptionLines. More...
 
void abs_linesPrintDefinedQuantumNumbers (const ArrayOfAbsorptionLines &abs_lines, const Verbosity &verbosity)
 WORKSPACE METHOD: abs_linesPrintDefinedQuantumNumbers. More...
 

Detailed Description

Contains the absorption namespace.

Author
Richard Larsson
Date
2019-09-11

Contains the user interaction with absorption lines

Definition in file m_absorptionlines.cc.

Enumeration Type Documentation

◆ HitranType

enum HitranType
strong
Enumerator
Pre2004 
Post2004 
Online 

Definition at line 425 of file m_absorptionlines.cc.

Function Documentation

◆ abs_lines_per_speciesChangeBaseParameterForMatchingLevel()

void abs_lines_per_speciesChangeBaseParameterForMatchingLevel ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index relative,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForMatchingLevel.

See abs_linesChangeBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")

Definition at line 2260 of file m_absorptionlines.cc.

References abs_linesChangeBaseParameterForMatchingLevel().

Referenced by abs_lines_per_speciesChangeBaseParameterForMatchingLevel_g().

◆ abs_lines_per_speciesChangeBaseParameterForMatchingLevels()

void abs_lines_per_speciesChangeBaseParameterForMatchingLevels ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfQuantumIdentifier QI,
const String parameter_name,
const Vector change,
const Index relative,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForMatchingLevels.

See abs_linesChangeBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")

Definition at line 2288 of file m_absorptionlines.cc.

References abs_linesChangeBaseParameterForMatchingLevel(), Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by abs_lines_per_speciesChangeBaseParameterForMatchingLevels_g().

◆ abs_lines_per_speciesChangeBaseParameterForMatchingLines()

void abs_lines_per_speciesChangeBaseParameterForMatchingLines ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index relative,
const Index loose_matching,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForMatchingLines.

See abs_linesChangeBaseParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")
[in]loose_matchingGeneric Input (Default: "0")

Definition at line 1877 of file m_absorptionlines.cc.

References abs_linesChangeBaseParameterForMatchingLines().

Referenced by abs_lines_per_speciesChangeBaseParameterForMatchingLines_g().

◆ abs_lines_per_speciesChangeBaseParameterForSpecies()

void abs_lines_per_speciesChangeBaseParameterForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index relative,
const Index loose_matching,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesChangeBaseParameterForSpecies.

See abs_linesChangeBaseParameterForMatchingLines but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")
[in]loose_matchingGeneric Input (Default: "0")
[in]species_tagGeneric Input

Definition at line 1890 of file m_absorptionlines.cc.

References abs_linesChangeBaseParameterForMatchingLines(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesChangeBaseParameterForSpecies_g().

◆ abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines()

void abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const QuantumIdentifier QI,
const String parameter,
const String coefficient,
const String species,
const Numeric change,
const Index relative,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines.

See abs_linesChangeLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameterGeneric Input
[in]coefficientGeneric Input
[in]speciesGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")

Definition at line 2067 of file m_absorptionlines.cc.

References abs_linesChangeLineShapeModelParameterForMatchingLines().

Referenced by abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines_g().

◆ abs_lines_per_speciesChangeLineShapeModelParameterForSpecies()

void abs_lines_per_speciesChangeLineShapeModelParameterForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const QuantumIdentifier QI,
const String parameter,
const String coefficient,
const String species,
const Numeric change,
const Index relative,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesChangeLineShapeModelParameterForSpecies.

See abs_linesChangeLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]QIGeneric Input
[in]parameterGeneric Input
[in]coefficientGeneric Input
[in]speciesGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")
[in]species_tagGeneric Input

Definition at line 2083 of file m_absorptionlines.cc.

References abs_linesChangeLineShapeModelParameterForMatchingLines(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesChangeLineShapeModelParameterForSpecies_g().

◆ abs_lines_per_speciesCompact()

void abs_lines_per_speciesCompact ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const Vector f_grid,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesCompact.

See abs_linesCompact

Author
Stefan Buehler
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]f_gridWS Input

Definition at line 2486 of file m_absorptionlines.cc.

References abs_linesCompact().

Referenced by abs_lines_per_speciesCompact_g().

◆ abs_lines_per_speciesReadSpeciesSplitCatalog()

void abs_lines_per_speciesReadSpeciesSplitCatalog ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String basename,
const Index robust,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesReadSpeciesSplitCatalog.

See abs_lines_per_speciesReadSplitCatalog but expects a single file per species of ArrayOfAbsorptionLines

Author
Richard Larsson
Parameters
[out]abs_lines_per_speciesWS Output
[in]abs_speciesWS Input
[in]basenameGeneric Input
[in]robustGeneric Input (Default: "0")

Definition at line 914 of file m_absorptionlines.cc.

References CREATE_OUT3, global_data::species_data, SpeciesTag::TYPE_PLAIN, and SpeciesTag::TYPE_ZEEMAN.

Referenced by abs_lines_per_speciesReadSpeciesSplitCatalog_g().

◆ abs_lines_per_speciesReadSplitCatalog()

void abs_lines_per_speciesReadSplitCatalog ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String basename,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesReadSplitCatalog.

Reads abs_lines_per_species split by abs_linesWriteSplitXML* or abs_lines_per_speciesWriteSplitXML

Note that this will sort the isotopologue

Author
Richard Larsson
Parameters
[out]abs_lines_per_speciesWS Output
[in]abs_speciesWS Input
[in]basenameGeneric Input

Definition at line 828 of file m_absorptionlines.cc.

References global_data::species_data, SpeciesTag::TYPE_PLAIN, and SpeciesTag::TYPE_ZEEMAN.

Referenced by abs_lines_per_speciesReadSplitCatalog_g().

◆ abs_lines_per_speciesSetBaseParameterForMatchingLevel()

void abs_lines_per_speciesSetBaseParameterForMatchingLevel ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForMatchingLevel.

See abs_linesSetBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input

Definition at line 2366 of file m_absorptionlines.cc.

References abs_linesSetBaseParameterForMatchingLevel().

Referenced by abs_lines_per_speciesSetBaseParameterForMatchingLevel_g().

◆ abs_lines_per_speciesSetBaseParameterForMatchingLevels()

void abs_lines_per_speciesSetBaseParameterForMatchingLevels ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfQuantumIdentifier QI,
const String parameter_name,
const Vector change,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForMatchingLevels.

See abs_linesSetBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input

Definition at line 2392 of file m_absorptionlines.cc.

References abs_linesSetBaseParameterForMatchingLevel(), Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by abs_lines_per_speciesSetBaseParameterForMatchingLevels_g().

◆ abs_lines_per_speciesSetBaseParameterForMatchingLines()

void abs_lines_per_speciesSetBaseParameterForMatchingLines ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index loose_matching,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForMatchingLines.

See abs_linesSetBaseParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]loose_matchingGeneric Input (Default: "0")

Definition at line 1984 of file m_absorptionlines.cc.

References abs_linesSetBaseParameterForMatchingLines().

Referenced by abs_lines_per_speciesSetBaseParameterForMatchingLines_g().

◆ abs_lines_per_speciesSetBaseParameterForSpecies()

void abs_lines_per_speciesSetBaseParameterForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index loose_matching,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetBaseParameterForSpecies.

See abs_linesSetBaseParameterForMatchingLines but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]loose_matchingGeneric Input (Default: "0")
[in]species_tagGeneric Input

Definition at line 1996 of file m_absorptionlines.cc.

References abs_linesSetBaseParameterForMatchingLines(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetBaseParameterForSpecies_g().

◆ abs_lines_per_speciesSetCutoff()

void abs_lines_per_speciesSetCutoff ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetCutoff.

See abs_linesSetCutoff

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input
[in]valueGeneric Input

Definition at line 1341 of file m_absorptionlines.cc.

References abs_linesSetCutoff().

Referenced by abs_lines_per_speciesSetCutoff_g().

◆ abs_lines_per_speciesSetCutoffForMatch()

void abs_lines_per_speciesSetCutoffForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const Numeric value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetCutoffForMatch.

See abs_linesSetCutoff for more options.

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 1368 of file m_absorptionlines.cc.

References abs_linesSetCutoffForMatch().

Referenced by abs_lines_per_speciesSetCutoffForMatch_g().

◆ abs_lines_per_speciesSetCutoffForSpecies()

void abs_lines_per_speciesSetCutoffForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String option,
const Numeric value,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetCutoffForSpecies.

See abs_linesSetCutoff but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]optionGeneric Input
[in]valueGeneric Input
[in]species_tagGeneric Input

Definition at line 1381 of file m_absorptionlines.cc.

References abs_linesSetCutoff(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetCutoffForSpecies_g().

◆ abs_lines_per_speciesSetEmpty()

void abs_lines_per_speciesSetEmpty ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetEmpty.

Empties abs_lines_per_species at the correct size.

Author
Richard Larsson
Parameters
[out]abs_lines_per_speciesWS Output
[in]abs_speciesWS Input

Definition at line 2458 of file m_absorptionlines.cc.

References Array< base >::nelem().

Referenced by abs_lines_per_speciesSetEmpty_g().

◆ abs_lines_per_speciesSetLinemixingLimit()

void abs_lines_per_speciesSetLinemixingLimit ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLinemixingLimit.

See abs_linesSetLinemixingLimit

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]valueGeneric Input

Definition at line 1667 of file m_absorptionlines.cc.

References abs_linesSetLinemixingLimit().

Referenced by abs_lines_per_speciesSetLinemixingLimit_g().

◆ abs_lines_per_speciesSetLinemixingLimitForMatch()

void abs_lines_per_speciesSetLinemixingLimitForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const Numeric value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLinemixingLimitForMatch.

See abs_linesSetLinemixingLimit for values

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 1687 of file m_absorptionlines.cc.

References abs_linesSetLinemixingLimitForMatch().

Referenced by abs_lines_per_speciesSetLinemixingLimitForMatch_g().

◆ abs_lines_per_speciesSetLinemixingLimitForSpecies()

void abs_lines_per_speciesSetLinemixingLimitForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const Numeric value,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLinemixingLimitForSpecies.

See abs_linesSetLinemixingLimit but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]valueGeneric Input
[in]species_tagGeneric Input

Definition at line 1697 of file m_absorptionlines.cc.

References abs_linesSetLinemixingLimit(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetLinemixingLimitForSpecies_g().

◆ abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines()

void abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const QuantumIdentifier QI,
const String parameter,
const String coefficient,
const String species,
const Numeric change,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines.

See abs_linesSetLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]QIGeneric Input
[in]parameterGeneric Input
[in]coefficientGeneric Input
[in]speciesGeneric Input
[in]changeGeneric Input

Definition at line 2144 of file m_absorptionlines.cc.

References abs_linesSetLineShapeModelParameterForMatchingLines().

Referenced by abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines_g().

◆ abs_lines_per_speciesSetLineShapeModelParameterForSpecies()

void abs_lines_per_speciesSetLineShapeModelParameterForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const QuantumIdentifier QI,
const String parameter,
const String coefficient,
const String species,
const Numeric change,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeModelParameterForSpecies.

See abs_linesSetLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]QIGeneric Input
[in]parameterGeneric Input
[in]coefficientGeneric Input
[in]speciesGeneric Input
[in]changeGeneric Input
[in]species_tagGeneric Input

Definition at line 2159 of file m_absorptionlines.cc.

References abs_linesSetLineShapeModelParameterForMatchingLines(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetLineShapeModelParameterForSpecies_g().

◆ abs_lines_per_speciesSetLineShapeType()

void abs_lines_per_speciesSetLineShapeType ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeType.

See abs_linesSetLineShapeType

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input

Definition at line 1605 of file m_absorptionlines.cc.

References abs_linesSetLineShapeType().

Referenced by abs_lines_per_speciesSetLineShapeType_g().

◆ abs_lines_per_speciesSetLineShapeTypeForMatch()

void abs_lines_per_speciesSetLineShapeTypeForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeTypeForMatch.

See abs_linesSetLineShapeType for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1626 of file m_absorptionlines.cc.

References abs_linesSetLineShapeTypeForMatch().

Referenced by abs_lines_per_speciesSetLineShapeTypeForMatch_g().

◆ abs_lines_per_speciesSetLineShapeTypeForSpecies()

void abs_lines_per_speciesSetLineShapeTypeForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String option,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetLineShapeTypeForSpecies.

See abs_linesSetLineShapeType but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]optionGeneric Input
[in]species_tagGeneric Input

Definition at line 1636 of file m_absorptionlines.cc.

References abs_linesSetLineShapeType(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetLineShapeTypeForSpecies_g().

◆ abs_lines_per_speciesSetMirroring()

void abs_lines_per_speciesSetMirroring ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetMirroring.

See abs_linesSetMirroring

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input

Definition at line 1414 of file m_absorptionlines.cc.

References abs_linesSetMirroring().

Referenced by abs_lines_per_speciesSetMirroring_g().

◆ abs_lines_per_speciesSetMirroringForMatch()

void abs_lines_per_speciesSetMirroringForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetMirroringForMatch.

See abs_linesSetMirroring for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1437 of file m_absorptionlines.cc.

References abs_linesSetMirroringForMatch().

Referenced by abs_lines_per_speciesSetMirroringForMatch_g().

◆ abs_lines_per_speciesSetMirroringForSpecies()

void abs_lines_per_speciesSetMirroringForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String option,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetMirroringForSpecies.

See abs_linesSetMirroring but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]optionGeneric Input
[in]species_tagGeneric Input

Definition at line 1447 of file m_absorptionlines.cc.

References abs_linesSetMirroring(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetMirroringForSpecies_g().

◆ abs_lines_per_speciesSetNormalization()

void abs_lines_per_speciesSetNormalization ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetNormalization.

See abs_linesSetNormalization

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input

Definition at line 1542 of file m_absorptionlines.cc.

References abs_linesSetNormalization().

Referenced by abs_lines_per_speciesSetNormalization_g().

◆ abs_lines_per_speciesSetNormalizationForMatch()

void abs_lines_per_speciesSetNormalizationForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetNormalizationForMatch.

See abs_linesSetNormalization for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1563 of file m_absorptionlines.cc.

References abs_linesSetNormalizationForMatch().

Referenced by abs_lines_per_speciesSetNormalizationForMatch_g().

◆ abs_lines_per_speciesSetNormalizationForSpecies()

void abs_lines_per_speciesSetNormalizationForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String option,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetNormalizationForSpecies.

See abs_linesSetNormalization but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]optionGeneric Input
[in]species_tagGeneric Input

Definition at line 1573 of file m_absorptionlines.cc.

References abs_linesSetNormalization(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetNormalizationForSpecies_g().

◆ abs_lines_per_speciesSetPopulation()

void abs_lines_per_speciesSetPopulation ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetPopulation.

See abs_linesSetPopulation

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input

Definition at line 1479 of file m_absorptionlines.cc.

References abs_linesSetPopulation().

Referenced by abs_lines_per_speciesSetPopulation_g().

◆ abs_lines_per_speciesSetPopulationForMatch()

void abs_lines_per_speciesSetPopulationForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetPopulationForMatch.

See abs_linesSetPopulation for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1500 of file m_absorptionlines.cc.

References abs_linesSetPopulationForMatch().

Referenced by abs_lines_per_speciesSetPopulationForMatch_g().

◆ abs_lines_per_speciesSetPopulationForSpecies()

void abs_lines_per_speciesSetPopulationForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const String option,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetPopulationForSpecies.

See abs_linesSetPopulation but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]optionGeneric Input
[in]species_tagGeneric Input

Definition at line 1510 of file m_absorptionlines.cc.

References abs_linesSetPopulation(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetPopulationForSpecies_g().

◆ abs_lines_per_speciesSetQuantumNumberForMatch()

void abs_lines_per_speciesSetQuantumNumberForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String quantum_number,
const Rational value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetQuantumNumberForMatch.

See abs_linesSetQuantumNumberForMatch

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]quantum_numberGeneric Input
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 996 of file m_absorptionlines.cc.

References abs_linesSetQuantumNumberForMatch().

Referenced by abs_lines_per_speciesSetQuantumNumberForMatch_g().

◆ abs_lines_per_speciesSetT0()

void abs_lines_per_speciesSetT0 ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetT0.

See abs_linesSetT0

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]valueGeneric Input

Definition at line 1728 of file m_absorptionlines.cc.

References abs_linesSetT0().

Referenced by abs_lines_per_speciesSetT0_g().

◆ abs_lines_per_speciesSetT0ForMatch()

void abs_lines_per_speciesSetT0ForMatch ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const Numeric value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetT0ForMatch.

Sets reference temperature

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 1748 of file m_absorptionlines.cc.

References abs_linesSetT0ForMatch().

Referenced by abs_lines_per_speciesSetT0ForMatch_g().

◆ abs_lines_per_speciesSetT0ForSpecies()

void abs_lines_per_speciesSetT0ForSpecies ( ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const ArrayOfArrayOfSpeciesTag abs_species,
const Numeric value,
const String species_tag,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesSetT0ForSpecies.

See abs_linesSetT0 but for single species

Author
Richard Larsson
Parameters
[in,out]abs_lines_per_speciesWS Input/Output
[in]abs_speciesWS Input
[in]valueGeneric Input
[in]species_tagGeneric Input

Definition at line 1758 of file m_absorptionlines.cc.

References abs_linesSetT0(), abs_speciesSet(), Zeeman::end(), and Array< base >::nelem().

Referenced by abs_lines_per_speciesSetT0ForSpecies_g().

◆ abs_lines_per_speciesWriteSpeciesSplitXML()

void abs_lines_per_speciesWriteSpeciesSplitXML ( const String output_file_format,
const ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String basename,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesWriteSpeciesSplitXML.

See abs_linesWriteSpeciesSplitXML

In addition, the structure of the files generated will not care about generating identifiers for the order in abs_species

Author
Richard Larsson
Parameters
[in]output_file_formatWS Input
[in]abs_lines_per_speciesWS Input
[in]basenameGeneric Input

Definition at line 810 of file m_absorptionlines.cc.

References abs_linesWriteSpeciesSplitXML().

Referenced by abs_lines_per_speciesWriteSpeciesSplitXML_g().

◆ abs_lines_per_speciesWriteSplitXML()

void abs_lines_per_speciesWriteSplitXML ( const String output_file_format,
const ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const String basename,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_lines_per_speciesWriteSplitXML.

See abs_linesWriteSplitXML

In addition, the structure of the files generated will not care about generating identifiers for the order in abs_species

Author
Richard Larsson
Parameters
[in]output_file_formatWS Input
[in]abs_lines_per_speciesWS Input
[in]basenameGeneric Input

Definition at line 786 of file m_absorptionlines.cc.

References WriteXML().

Referenced by abs_lines_per_speciesWriteSplitXML_g().

◆ abs_linesAppendWithLines()

void abs_linesAppendWithLines ( ArrayOfAbsorptionLines abs_lines,
const ArrayOfAbsorptionLines appending_lines,
const Index safe,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesAppendWithLines.

Appends all lines in abs_lines that match with lines in replacement_lines if safe. If not safe, appends all lines.

No appended line is allowed to match any line in abs_lines if safe

Conditional behavior if safe: If the AbosorptionLines to be appended match no AbsorptionLines in abs_lines, then the entire AbsorptionLines is appended. Otherwise, only a single AbsorptionLines can be matched and is not allowed to have any internal matches

Note that lines are identified by their AbsorptionLines tags and by their quantum numbers in safe mode.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]appending_linesGeneric Input
[in]safeGeneric Input (Default: "1")

Definition at line 1081 of file m_absorptionlines.cc.

Referenced by abs_linesAppendWithLines_g().

◆ abs_linesChangeBaseParameterForMatchingLevel()

void abs_linesChangeBaseParameterForMatchingLevel ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index relative,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesChangeBaseParameterForMatchingLevel.

Change parameter of all levels in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Statistical Weight" parameter_name = "Zeeman Coefficient"

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")

Definition at line 2186 of file m_absorptionlines.cc.

References QuantumIdentifier::ENERGY_LEVEL, my_basic_string< charT >::nelem(), and QuantumIdentifier::Type().

Referenced by abs_lines_per_speciesChangeBaseParameterForMatchingLevel(), abs_lines_per_speciesChangeBaseParameterForMatchingLevels(), abs_linesChangeBaseParameterForMatchingLevel_g(), and abs_linesChangeBaseParameterForMatchingLevels().

◆ abs_linesChangeBaseParameterForMatchingLevels()

void abs_linesChangeBaseParameterForMatchingLevels ( ArrayOfAbsorptionLines abs_lines,
const ArrayOfQuantumIdentifier QI,
const String parameter_name,
const Vector change,
const Index relative,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesChangeBaseParameterForMatchingLevels.

See abs_linesChangeBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")

Definition at line 2272 of file m_absorptionlines.cc.

References abs_linesChangeBaseParameterForMatchingLevel(), Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by abs_linesChangeBaseParameterForMatchingLevels_g().

◆ abs_linesChangeBaseParameterForMatchingLines()

void abs_linesChangeBaseParameterForMatchingLines ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index relative,
const Index loose_matching,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesChangeBaseParameterForMatchingLines.

Change parameter of all lines in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Central Frequency" parameter_name = "Line Strength" parameter_name = "Lower State Energy" parameter_name = "Einstein Coefficient" parameter_name = "Lower Statistical Weight" parameter_name = "Upper Statistical Weight" parameter_name = "Lower Zeeman Coefficient" parameter_name = "Upper Zeeman Coefficient"

Note that loose_matching:=0 means only identical quantum identifiers are accepted, otherwise the numbers in QI must just be contained in the line identifier

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")
[in]loose_matchingGeneric Input (Default: "0")

Definition at line 1780 of file m_absorptionlines.cc.

References my_basic_string< charT >::nelem().

Referenced by abs_lines_per_speciesChangeBaseParameterForMatchingLines(), abs_lines_per_speciesChangeBaseParameterForSpecies(), and abs_linesChangeBaseParameterForMatchingLines_g().

◆ abs_linesChangeLineShapeModelParameterForMatchingLines()

void abs_linesChangeLineShapeModelParameterForMatchingLines ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier QI,
const String parameter,
const String coefficient,
const String species,
const Numeric change,
const Index relative,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesChangeLineShapeModelParameterForMatchingLines.

Change line shape model data parameter in matching lines.

The matching is done so that QI must be in the line identifier

Acceptable parameter(s) are: "G0" "D0" "G2" "D2" "FVC" "ETA" "Y" "G" "DV"

Acceptable coefficient(s) are: "X0" "X1" "X2" "X3"

Acceptable species are: "AIR" (so long as it is the broadening species list) "SELF" (so long as it is the broadening species list) Any species in the line broadening species

The line parameter will have its old value plus the change if relative is false, else it will have its old value times (1+change).

Throws an error if it cannot find any targets to change

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameterGeneric Input
[in]coefficientGeneric Input
[in]speciesGeneric Input
[in]changeGeneric Input
[in]relativeGeneric Input (Default: "0")

Definition at line 2017 of file m_absorptionlines.cc.

References SpeciesTag::Species(), LineShape::string2variable(), and linalg::var().

Referenced by abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines(), abs_lines_per_speciesChangeLineShapeModelParameterForSpecies(), and abs_linesChangeLineShapeModelParameterForMatchingLines_g().

◆ abs_linesCleanupEmpty()

void abs_linesCleanupEmpty ( ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesCleanupEmpty.

Removes empty bands from abs_lines.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output

Definition at line 1310 of file m_absorptionlines.cc.

References i, and Array< base >::nelem().

Referenced by abs_linesCleanupEmpty_g().

◆ abs_linesCompact()

void abs_linesCompact ( ArrayOfAbsorptionLines abs_lines,
const Vector f_grid,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesCompact.

Removes lines that are unimportant because of their cutoff frequency range

Author
Stefan Buehler
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]f_gridWS Input

Definition at line 2465 of file m_absorptionlines.cc.

References Absorption::BandFixedFrequency, max, and min.

Referenced by abs_lines_per_speciesCompact(), and abs_linesCompact_g().

◆ abs_linesDeleteBadF0()

void abs_linesDeleteBadF0 ( ArrayOfAbsorptionLines abs_lines,
const Numeric f0,
const Index lower,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesDeleteBadF0.

Deletes all lines in abs_lines that have bad central frequencies

If lower evaluates as true, deletes all lines with a frequency below f0. Otherwise deletes all lines with a frequency above f0.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]f0Generic Input
[in]lowerGeneric Input (Default: "1")

Definition at line 1124 of file m_absorptionlines.cc.

References i.

Referenced by abs_linesDeleteBadF0_g().

◆ abs_linesDeleteLinesWithBadOrHighChangingJs()

void abs_linesDeleteLinesWithBadOrHighChangingJs ( ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesDeleteLinesWithBadOrHighChangingJs.

Deletes all lines in abs_lines that have undefined Js or Js that change more than 1 between energy levels

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output

Definition at line 1209 of file m_absorptionlines.cc.

References abs, CREATE_OUT2, i, and J.

Referenced by abs_linesDeleteLinesWithBadOrHighChangingJs_g().

◆ abs_linesDeleteLinesWithQuantumNumberAbove()

void abs_linesDeleteLinesWithQuantumNumberAbove ( ArrayOfAbsorptionLines abs_lines,
const String quantumnumber,
const Index quantumnumber_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesDeleteLinesWithQuantumNumberAbove.

Deletes all lines in abs_lines that have too large quantum number

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]quantumnumberGeneric Input
[in]quantumnumber_valueGeneric Input

Definition at line 1237 of file m_absorptionlines.cc.

References i, and string2quantumnumbertype().

Referenced by abs_linesDeleteLinesWithQuantumNumberAbove_g().

◆ abs_linesDeleteLinesWithUndefinedLocalQuanta()

void abs_linesDeleteLinesWithUndefinedLocalQuanta ( ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesDeleteLinesWithUndefinedLocalQuanta.

Deletes all lines in abs_lines that have undefined local quanta

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output

Definition at line 1179 of file m_absorptionlines.cc.

References CREATE_OUT2, and i.

Referenced by abs_linesDeleteLinesWithUndefinedLocalQuanta_g().

◆ abs_linesDeleteWithLines()

void abs_linesDeleteWithLines ( ArrayOfAbsorptionLines abs_lines,
const ArrayOfAbsorptionLines deleting_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesDeleteWithLines.

Deletes all lines in abs_lines that match with lines in replacement_lines.

If a deleted line has no match, then nothing happens.

Note that lines are identified by their AbsorptionLines tags and by their quantum numbers. There is no need to have all values correct.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]deleting_linesGeneric Input

Definition at line 1145 of file m_absorptionlines.cc.

References i, and n.

Referenced by abs_linesDeleteWithLines_g().

◆ abs_linesKeepBands()

void abs_linesKeepBands ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier qid,
const Index ignore_spec,
const Index ignore_isot,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesKeepBands.

Keep only qid-matches in abs_lines

The ignore values will ignore isotopologue and/or species. The latter means the isotopologue has to be ignores.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]qidGeneric Input
[in]ignore_specGeneric Input (Default: "1")
[in]ignore_isotGeneric Input (Default: "1")

Definition at line 1281 of file m_absorptionlines.cc.

References QuantumIdentifier::ENERGY_LEVEL, QuantumIdentifier::EnergyLevelQuantumNumbers(), QuantumIdentifier::Isotopologue(), QuantumIdentifier::LowerQuantumNumbers(), QuantumIdentifier::SetTransition(), QuantumIdentifier::Species(), QuantumIdentifier::Type(), and QuantumIdentifier::UpperQuantumNumbers().

Referenced by abs_linesKeepBands_g().

◆ abs_linesPrintDefinedQuantumNumbers()

void abs_linesPrintDefinedQuantumNumbers ( const ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesPrintDefinedQuantumNumbers.

Print the count of defined quantum numbers in the catalog

Author
Richard Larsson
Parameters
[in]abs_linesWS Input

Definition at line 2579 of file m_absorptionlines.cc.

References CREATE_OUT0, FINAL_ENTRY, and quantumnumbertype2string().

Referenced by abs_linesPrintDefinedQuantumNumbers_g().

◆ abs_linesReadSpeciesSplitCatalog()

void abs_linesReadSpeciesSplitCatalog ( ArrayOfAbsorptionLines abs_lines,
const String basename,
const Index robust,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesReadSpeciesSplitCatalog.

Reads a catalog of absorption lines files in a directory

Author
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]basenameGeneric Input
[in]robustGeneric Input (Default: "0")

Definition at line 874 of file m_absorptionlines.cc.

References CREATE_OUT3, and global_data::species_data.

Referenced by abs_linesReadSpeciesSplitCatalog_g().

◆ abs_linesRemoveBand()

void abs_linesRemoveBand ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier qid,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesRemoveBand.

Removes qid band from abs_lines

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]qidGeneric Input

Definition at line 2496 of file m_absorptionlines.cc.

References i, QuantumIdentifier::In(), and Array< base >::nelem().

Referenced by abs_linesRemoveBand_g().

◆ abs_linesRemoveUnusedLocalQuantumNumbers()

void abs_linesRemoveUnusedLocalQuantumNumbers ( ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesRemoveUnusedLocalQuantumNumbers.

Removes unused quantums from local values in the line lists

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output

Definition at line 1037 of file m_absorptionlines.cc.

Referenced by abs_linesRemoveUnusedLocalQuantumNumbers_g().

◆ abs_linesReplaceWithLines()

void abs_linesReplaceWithLines ( ArrayOfAbsorptionLines abs_lines,
const ArrayOfAbsorptionLines replacing_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesReplaceWithLines.

Replace all lines in abs_lines that match with lines in replacement_lines.

Each replacement_lines must match excatly a single line in abs_lines.

The matching required identical quantum number signatures to work

Note that lines are identified by their AbsorptionLines tags and by their quantum numbers.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]replacing_linesGeneric Input

Definition at line 1050 of file m_absorptionlines.cc.

Referenced by abs_linesReplaceWithLines_g().

◆ abs_linesSetBaseParameterForMatchingLevel()

void abs_linesSetBaseParameterForMatchingLevel ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetBaseParameterForMatchingLevel.

Set parameter of all levels in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Statistical Weight" parameter_name = "Zeeman Coefficient"

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input

Definition at line 2305 of file m_absorptionlines.cc.

References QuantumIdentifier::ENERGY_LEVEL, my_basic_string< charT >::nelem(), and QuantumIdentifier::Type().

Referenced by abs_lines_per_speciesSetBaseParameterForMatchingLevel(), abs_lines_per_speciesSetBaseParameterForMatchingLevels(), abs_linesSetBaseParameterForMatchingLevel_g(), and abs_linesSetBaseParameterForMatchingLevels().

◆ abs_linesSetBaseParameterForMatchingLevels()

void abs_linesSetBaseParameterForMatchingLevels ( ArrayOfAbsorptionLines abs_lines,
const ArrayOfQuantumIdentifier QI,
const String parameter_name,
const Vector change,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetBaseParameterForMatchingLevels.

See abs_linesSetBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input

Definition at line 2377 of file m_absorptionlines.cc.

References abs_linesSetBaseParameterForMatchingLevel(), Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by abs_linesSetBaseParameterForMatchingLevels_g().

◆ abs_linesSetBaseParameterForMatchingLines()

void abs_linesSetBaseParameterForMatchingLines ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier QI,
const String parameter_name,
const Numeric change,
const Index loose_matching,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetBaseParameterForMatchingLines.

Set parameter of all lines in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Central Frequency" parameter_name = "Line Strength" parameter_name = "Lower State Energy" parameter_name = "Einstein Coefficient" parameter_name = "Lower Statistical Weight" parameter_name = "Upper Statistical Weight" parameter_name = "Lower Zeeman Coefficient" parameter_name = "Upper Zeeman Coefficient"

Note that loose_matching:=0 means only identical quantum identifiers are accepted, otherwise the numbers in QI must just be contained in the line identifier

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameter_nameGeneric Input
[in]changeGeneric Input
[in]loose_matchingGeneric Input (Default: "0")

Definition at line 1912 of file m_absorptionlines.cc.

References my_basic_string< charT >::nelem().

Referenced by abs_lines_per_speciesSetBaseParameterForMatchingLines(), abs_lines_per_speciesSetBaseParameterForSpecies(), and abs_linesSetBaseParameterForMatchingLines_g().

◆ abs_linesSetCutoff()

void abs_linesSetCutoff ( ArrayOfAbsorptionLines abs_lines,
const String option,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetCutoff.

Sets cutoff type and magnitude for all lines.

The line is cut off when this is active at the given frequency. The only non-zero range is from this range to its negative equivalent

Available options: "None" - No cutoff "ByLine" - Cutoff relative line center, highest frequency: F0+cutoff "ByBand" - Absolute frequency, highest frequency: cutoff

For "ByLine", the negative frequency is at F0-cutoff For "ByBand", the negative frequency is at cutoff minus twice the average band frequency

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input
[in]valueGeneric Input

Definition at line 1328 of file m_absorptionlines.cc.

References Absorption::string2cutofftype().

Referenced by abs_lines_per_speciesSetCutoff(), abs_lines_per_speciesSetCutoffForSpecies(), abs_linesSetCutoff_g(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().

◆ abs_linesSetCutoffForMatch()

void abs_linesSetCutoffForMatch ( ArrayOfAbsorptionLines abs_lines,
const String option,
const Numeric value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetCutoffForMatch.

See abs_linesSetCutoff for more options.

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 1351 of file m_absorptionlines.cc.

References QuantumIdentifier::In(), and Absorption::string2cutofftype().

Referenced by abs_lines_per_speciesSetCutoffForMatch(), and abs_linesSetCutoffForMatch_g().

◆ abs_linesSetEmptyBroadeningParametersToEmpty()

void abs_linesSetEmptyBroadeningParametersToEmpty ( ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetEmptyBroadeningParametersToEmpty.

Sets a broadening parameter to empty if it is efficiently empty

This will not save RAM but it will save disk space (reading time), and computational time by not doing unecessary calculations

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output

Definition at line 1251 of file m_absorptionlines.cc.

References LineShape::modelparameterEmpty(), LineShape::None, and LineShape::nVars.

Referenced by abs_linesSetEmptyBroadeningParametersToEmpty_g().

◆ abs_linesSetLinemixingLimit()

void abs_linesSetLinemixingLimit ( ArrayOfAbsorptionLines abs_lines,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetLinemixingLimit.

Sets line mixing limit for all lines.

If value is less than 0, no limit is applied and line mixing is active. Otherwise, line mixing is inactive if the pressure is below the limit.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]valueGeneric Input

Definition at line 1658 of file m_absorptionlines.cc.

Referenced by abs_lines_per_speciesSetLinemixingLimit(), abs_lines_per_speciesSetLinemixingLimitForSpecies(), abs_linesSetLinemixingLimit_g(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().

◆ abs_linesSetLinemixingLimitForMatch()

void abs_linesSetLinemixingLimitForMatch ( ArrayOfAbsorptionLines abs_lines,
const Numeric value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetLinemixingLimitForMatch.

See abs_linesSetLinemixingLimit for values

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 1676 of file m_absorptionlines.cc.

References QuantumIdentifier::In().

Referenced by abs_lines_per_speciesSetLinemixingLimitForMatch(), and abs_linesSetLinemixingLimitForMatch_g().

◆ abs_linesSetLineShapeModelParameterForMatchingLines()

void abs_linesSetLineShapeModelParameterForMatchingLines ( ArrayOfAbsorptionLines abs_lines,
const QuantumIdentifier QI,
const String parameter,
const String coefficient,
const String species,
const Numeric change,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetLineShapeModelParameterForMatchingLines.

Sets line shape model data parameter in matching lines.

The matching is done so that QI must be in the line identifier

Acceptable parameter(s) are: "G0" "D0" "G2" "D2" "FVC" "ETA" "Y" "G" "DV"

Acceptable coefficient(s) are: "X0" "X1" "X2" "X3"

Acceptable species are: "AIR" (so long as it is the broadening species list) "SELF" (so long as it is the broadening species list) Any species in the line broadening species

Throws an error if it cannot find any targets to change

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]QIGeneric Input
[in]parameterGeneric Input
[in]coefficientGeneric Input
[in]speciesGeneric Input
[in]changeGeneric Input

Definition at line 2107 of file m_absorptionlines.cc.

References SpeciesTag::Species(), LineShape::string2variable(), and linalg::var().

Referenced by abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines(), abs_lines_per_speciesSetLineShapeModelParameterForSpecies(), and abs_linesSetLineShapeModelParameterForMatchingLines_g().

◆ abs_linesSetLineShapeType()

void abs_linesSetLineShapeType ( ArrayOfAbsorptionLines abs_lines,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetLineShapeType.

Sets shape calculations type for all lines.

Available options: "DP" - Doppler profile "LP" - Lorentz profile "VP" - Voigt profile "SDVP" - Speed-dependent Voigt profile "HTP" - Hartman-Tran profile

See the theory guide for more details.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input

Definition at line 1595 of file m_absorptionlines.cc.

References LineShape::string2shapetype().

Referenced by abs_lines_per_speciesSetLineShapeType(), abs_lines_per_speciesSetLineShapeTypeForSpecies(), abs_linesSetLineShapeType_g(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().

◆ abs_linesSetLineShapeTypeForMatch()

void abs_linesSetLineShapeTypeForMatch ( ArrayOfAbsorptionLines abs_lines,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetLineShapeTypeForMatch.

See abs_linesSetLineShapeType for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1614 of file m_absorptionlines.cc.

References QuantumIdentifier::In(), and LineShape::string2shapetype().

Referenced by abs_lines_per_speciesSetLineShapeTypeForMatch(), and abs_linesSetLineShapeTypeForMatch_g().

◆ abs_linesSetMirroring()

void abs_linesSetMirroring ( ArrayOfAbsorptionLines abs_lines,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetMirroring.

Sets mirroring type for all lines.

Available options: "None" - No mirrored line "Same" - Mirrored line broadened by line shape "Manual" - Manually mirrored line (be careful; allows all frequencies) "Lorentz" - Mirrored line broadened by Lorentz

Note that mirroring is never applied for DP line shape Also note that Lorentz profile is approached by most line shapes at high frequency offset. Also note that Manual settings are potentially dangerous as other frequency offsets might not work as hoped.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input

Definition at line 1404 of file m_absorptionlines.cc.

References Absorption::string2mirroringtype().

Referenced by abs_lines_per_speciesSetMirroring(), abs_lines_per_speciesSetMirroringForSpecies(), abs_linesSetMirroring_g(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().

◆ abs_linesSetMirroringForMatch()

void abs_linesSetMirroringForMatch ( ArrayOfAbsorptionLines abs_lines,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetMirroringForMatch.

See abs_linesSetMirroring for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1423 of file m_absorptionlines.cc.

References QuantumIdentifier::In(), and Absorption::string2mirroringtype().

Referenced by abs_lines_per_speciesSetMirroringForMatch(), and abs_linesSetMirroringForMatch_g().

◆ abs_linesSetNormalization()

void abs_linesSetNormalization ( ArrayOfAbsorptionLines abs_lines,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetNormalization.

Sets normalization type for all lines.

Available options: "VVH" - Van Vleck and Huber "VVW" - Van Vleck and Weisskopf "RQ" - Rosenkranz quadratic "None" - No extra normalization

See the theory guide for more details.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input

Definition at line 1532 of file m_absorptionlines.cc.

References Absorption::string2normalizationtype().

Referenced by abs_lines_per_speciesSetNormalization(), abs_lines_per_speciesSetNormalizationForSpecies(), abs_linesSetNormalization_g(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().

◆ abs_linesSetNormalizationForMatch()

void abs_linesSetNormalizationForMatch ( ArrayOfAbsorptionLines abs_lines,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetNormalizationForMatch.

See abs_linesSetNormalization for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1551 of file m_absorptionlines.cc.

References QuantumIdentifier::In(), and Absorption::string2normalizationtype().

Referenced by abs_lines_per_speciesSetNormalizationForMatch(), and abs_linesSetNormalizationForMatch_g().

◆ abs_linesSetPopulation()

void abs_linesSetPopulation ( ArrayOfAbsorptionLines abs_lines,
const String option,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetPopulation.

Sets population type for all lines.

Available options: "LTE" - Standard distribution by temperature "NLTE-VibrationalTemperatures" - LTE but with vibrational temperatures "NLTE" - Distribution is given as input

You must have set nlte_field and/or its ilk to use the NLTE methods.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input

Definition at line 1469 of file m_absorptionlines.cc.

References Absorption::string2populationtype().

Referenced by abs_lines_per_speciesSetPopulation(), abs_lines_per_speciesSetPopulationForSpecies(), abs_linesSetPopulation_g(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().

◆ abs_linesSetPopulationForMatch()

void abs_linesSetPopulationForMatch ( ArrayOfAbsorptionLines abs_lines,
const String option,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetPopulationForMatch.

See abs_linesSetPopulation for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]optionGeneric Input
[in]IDGeneric Input

Definition at line 1488 of file m_absorptionlines.cc.

References QuantumIdentifier::In(), and Absorption::string2populationtype().

Referenced by abs_lines_per_speciesSetPopulationForMatch(), and abs_linesSetPopulationForMatch_g().

◆ abs_linesSetQuantumNumberForMatch()

void abs_linesSetQuantumNumberForMatch ( ArrayOfAbsorptionLines abs_lines,
const String quantum_number,
const Rational value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetQuantumNumberForMatch.

Sets a quantum number to a new value

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]quantum_numberGeneric Input
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 971 of file m_absorptionlines.cc.

References FINAL_ENTRY, _CS_basic_sstream_base< _CS_cT, _CS_Tr, _CS_Al >::str(), and string2quantumnumbertype().

Referenced by abs_lines_per_speciesSetQuantumNumberForMatch(), and abs_linesSetQuantumNumberForMatch_g().

◆ abs_linesSetT0()

void abs_linesSetT0 ( ArrayOfAbsorptionLines abs_lines,
const Numeric value,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetT0.

Sets reference temperature for all lines.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]valueGeneric Input

Definition at line 1719 of file m_absorptionlines.cc.

Referenced by abs_lines_per_speciesSetT0(), abs_lines_per_speciesSetT0ForSpecies(), and abs_linesSetT0_g().

◆ abs_linesSetT0ForMatch()

void abs_linesSetT0ForMatch ( ArrayOfAbsorptionLines abs_lines,
const Numeric value,
const QuantumIdentifier ID,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesSetT0ForMatch.

Sets reference temperature

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output
[in]valueGeneric Input
[in]IDGeneric Input

Definition at line 1737 of file m_absorptionlines.cc.

References QuantumIdentifier::In().

Referenced by abs_lines_per_speciesSetT0ForMatch(), and abs_linesSetT0ForMatch_g().

◆ abs_linesTruncateGlobalQuantumNumbers()

void abs_linesTruncateGlobalQuantumNumbers ( ArrayOfAbsorptionLines abs_lines,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesTruncateGlobalQuantumNumbers.

Truncates all global quantum numbers and then recombine the line list.

Author
Richard Larsson
Parameters
[in,out]abs_linesWS Input/Output

Definition at line 1007 of file m_absorptionlines.cc.

References Array< base >::nelem().

Referenced by abs_linesTruncateGlobalQuantumNumbers_g().

◆ abs_linesWriteSpeciesSplitXML()

void abs_linesWriteSpeciesSplitXML ( const String output_file_format,
const ArrayOfAbsorptionLines abs_lines,
const String basename,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesWriteSpeciesSplitXML.

As abs_linesWriteSplitXML but writes an array per species

Author
Richard Larsson
Parameters
[in]output_file_formatWS Input
[in]abs_linesWS Input
[in]basenameGeneric Input

Definition at line 740 of file m_absorptionlines.cc.

References abs_lines_per_speciesCreateFromLines(), abs_speciesSet(), i, Array< base >::nelem(), and WriteXML().

Referenced by abs_lines_per_speciesWriteSpeciesSplitXML(), and abs_linesWriteSpeciesSplitXML_g().

◆ abs_linesWriteSplitXML()

void abs_linesWriteSplitXML ( const String output_file_format,
const ArrayOfAbsorptionLines abs_lines,
const String basename,
const Verbosity verbosity 
)

WORKSPACE METHOD: abs_linesWriteSplitXML.

Writes a split catalog, AbsorptionLines by AbsorptionLines.

There will be one unique file generated per AbsorptionLines in abs_lines.

The names of these files will be: basename+"."+AbsorptionLines.SpeciesName()+"."+to_string(N)+".xml" where N>=0 and the species name is something line "H2O".

Author
Richard Larsson
Parameters
[in]output_file_formatWS Input
[in]abs_linesWS Input
[in]basenameGeneric Input

Definition at line 718 of file m_absorptionlines.cc.

References WriteXML().

Referenced by abs_linesWriteSplitXML_g().

◆ f_gridFromAbsorptionLines()

void f_gridFromAbsorptionLines ( Vector f_grid,
const ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const Numeric delta_f_low,
const Numeric delta_f_upp,
const Index num_freqs,
const Verbosity verbosity 
)

WORKSPACE METHOD: f_gridFromAbsorptionLines.

Sets f_grid to a grid relative to abs_lines_per_species

Each line will have abs_lines_per_species will have a grid of num_freqs grid points in [f0+*delta_f_low*, f0+*delta_f_upp*], where f0 is the line center.

Before leaving the function, f_grid is sorted.

Note that this method could generate significantly large f_grid if used carelessly

Author
Richard Larsson
Parameters
[out]f_gridWS Output
[in]abs_lines_per_speciesWS Input
[in]delta_f_lowGeneric Input (Default: "-5e6")
[in]delta_f_uppGeneric Input (Default: "5e6")
[in]num_freqsGeneric Input

Definition at line 2532 of file m_absorptionlines.cc.

References n, and Absorption::nelem().

Referenced by f_gridFromAbsorptionLines_g().

◆ linspace()

template<class T >
std::vector<T> linspace ( s,
e,
typename std::vector< T >::size_type  count 
)
noexcept

◆ nlteSetByQuantumIdentifiers()

void nlteSetByQuantumIdentifiers ( Index nlte_do,
ArrayOfArrayOfAbsorptionLines abs_lines_per_species,
const EnergyLevelMap nlte_field,
const Verbosity verbosity 
)

WORKSPACE METHOD: nlteSetByQuantumIdentifiers.

Turns on NTLE calculations.

Takes the quantum identifers for NLTE temperatures and matches it to lines in abs_lines_per_species. abs_species must be set and is used to speed up calculations. After the function is done, all affected lines in abs_lines_per_species will have an internal tag to the relevant quantum identifier, which is a requirement for deeper code.

If vibrational_energies is input it must match nlte_level_identifiers in length. The vibrational energies of the affected lines will then be set by the function. Otherwise, it is assumed the vibrational energies are set by another method. If they are not set, calculations will complain later on while running deeper code.

For now only vibrational energy states are assumed to be able to be in non-LTE conditions. The QuantumIdentifier for an energy state in ARTS can look like: "CO2-626 EN v1 0/1 v2 1/1 l2 1/1 v3 0/1 r 1/1" and the matching will match ALL lines with the above. Note then that if, e.g., the "v1 0/1" term was removed from the above, then ARTS will assume that "v1" is not part of the level of energy state of interest, so lines of different "v1" will be matched as the same state. If a line is matched to more than one energy state, errors should be thrown, but be careful.

Set type of population to change computations and expected input as: LTE: Compute population by ratios found from LTE temperatures TV: Compute population by ratios found from NLTE vibrational temperatures ND: Compute population by ratios found from NLTE number densities

Author
Richard Larsson
Parameters
[out]nlte_doWS Output
[in,out]abs_lines_per_speciesWS Input/Output
[in]nlte_fieldWS Input

Definition at line 2412 of file m_absorptionlines.cc.

References Absorption::ByNLTEPopulationDistribution, Absorption::ByNLTEVibrationalTemperatures, EnergyLevelMap::Data(), ConstTensor4View::empty(), ConstVectorView::empty(), EnergyLevelMap::Energies(), EnergyLevelMap::Levels(), and EnergyLevelMap::ThrowIfNotOK().

Referenced by nlteSetByQuantumIdentifiers_g().

◆ ReadArrayOfARTSCAT()

void ReadArrayOfARTSCAT ( ArrayOfAbsorptionLines abs_lines,
const String filename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadArrayOfARTSCAT.

Reads an old Array<ArrayOfLineRecord> ARTSCAT file.

Note that the ARTSCAT-5 had quantum numbers and options stored inside it but that the options will overwrite that information. Be careful setting the options!

Author
Stefan Buehler
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]filenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 70 of file m_absorptionlines.cc.

References CREATE_OUT2, FILE_TYPE_ASCII, Absorption::nelem(), NUMERIC_TYPE_DOUBLE, string2vecqn(), and xml_find_and_open_input_file().

Referenced by ReadArrayOfARTSCAT_g().

◆ ReadARTSCAT()

void ReadARTSCAT ( ArrayOfAbsorptionLines abs_lines,
const String filename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadARTSCAT.

Reads an old ArrayOfLineRecord ARTSCAT file

Note that the ARTSCAT-5 had quantum numbers and options stored inside it but that the options will overwrite that information. Be careful setting the options!

Author
Stefan Buehler
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]filenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 201 of file m_absorptionlines.cc.

References CREATE_OUT2, FILE_TYPE_ASCII, Absorption::nelem(), NUMERIC_TYPE_DOUBLE, string2vecqn(), and xml_find_and_open_input_file().

Referenced by ReadARTSCAT_g(), and ReadSplitARTSCAT().

◆ ReadHITRAN()

void ReadHITRAN ( ArrayOfAbsorptionLines abs_lines,
const String filename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const String hitran_type,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadHITRAN.

Reads a HITRAN .par file.

The HITRAN type switch can be: "Pre2004" - for old format "Post2004" - for new format "Online" - for the online format with quantum numbers (highly experimental)

Be careful setting the options!

Author
Hermann Berg
Thomas Kuhn
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]filenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]hitran_typeGeneric Input (Default: "Post2004")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 446 of file m_absorptionlines.cc.

References abs_linesSetCutoff(), abs_linesSetLinemixingLimit(), abs_linesSetLineShapeType(), abs_linesSetMirroring(), abs_linesSetNormalization(), abs_linesSetPopulation(), Zeeman::GetAdvancedModel(), Online, open_input_file(), Post2004, Pre2004, Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), Absorption::split_list_of_external_lines(), string2hitrantype(), and string2vecqn().

Referenced by ReadHITRAN_g().

◆ ReadJPL()

void ReadJPL ( ArrayOfAbsorptionLines abs_lines,
const String filename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadJPL.

Reads a JPL file.

Be careful setting the options!

Author
Thomas Kuhn
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]filenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 651 of file m_absorptionlines.cc.

References abs_linesSetCutoff(), abs_linesSetLinemixingLimit(), abs_linesSetLineShapeType(), abs_linesSetMirroring(), abs_linesSetNormalization(), abs_linesSetPopulation(), Zeeman::GetAdvancedModel(), open_input_file(), Absorption::ReadFromJplStream(), Absorption::split_list_of_external_lines(), and string2vecqn().

Referenced by ReadJPL_g().

◆ ReadLBLRTM()

void ReadLBLRTM ( ArrayOfAbsorptionLines abs_lines,
const String filename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadLBLRTM.

Reads a LBLRTM file.

Be careful setting the options!

Author
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]filenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 525 of file m_absorptionlines.cc.

References abs_linesSetCutoff(), abs_linesSetLinemixingLimit(), abs_linesSetLineShapeType(), abs_linesSetMirroring(), abs_linesSetNormalization(), abs_linesSetPopulation(), Zeeman::GetAdvancedModel(), open_input_file(), Absorption::ReadFromLBLRTMStream(), Absorption::split_list_of_external_lines(), and string2vecqn().

Referenced by ReadLBLRTM_g().

◆ ReadMytran2()

void ReadMytran2 ( ArrayOfAbsorptionLines abs_lines,
const String filename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadMytran2.

Reads a Mytran2 file.

Be careful setting the options!

Author
Axel von Engeln
Stefan Buehler
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]filenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 588 of file m_absorptionlines.cc.

References abs_linesSetCutoff(), abs_linesSetLinemixingLimit(), abs_linesSetLineShapeType(), abs_linesSetMirroring(), abs_linesSetNormalization(), abs_linesSetPopulation(), Zeeman::GetAdvancedModel(), open_input_file(), Absorption::ReadFromMytran2Stream(), Absorption::split_list_of_external_lines(), and string2vecqn().

Referenced by ReadMytran2_g().

◆ ReadSplitARTSCAT()

void ReadSplitARTSCAT ( ArrayOfAbsorptionLines abs_lines,
const ArrayOfArrayOfSpeciesTag abs_species,
const String basename,
const Numeric fmin,
const Numeric fmax,
const String globalquantumnumbers,
const String localquantumnumbers,
const Index ignore_missing,
const String normalization_option,
const String mirroring_option,
const String population_option,
const String lineshapetype_option,
const String cutoff_option,
const Numeric cutoff_value,
const Numeric linemixinglimit_value,
const Verbosity verbosity 
)

WORKSPACE METHOD: ReadSplitARTSCAT.

Reads several old ArrayOfLineRecord ARTSCAT file

Note that the ARTSCAT-5 had quantum numbers and options stored inside it but that the options will overwrite that information. Be careful setting the options!

Author
Oliver Lemke
Richard Larsson
Parameters
[out]abs_linesWS Output
[in]abs_speciesWS Input
[in]basenameGeneric Input
[in]fminGeneric Input (Default: "0")
[in]fmaxGeneric Input (Default: "1e99")
[in]globalquantumnumbersGeneric Input (Default: "")
[in]localquantumnumbersGeneric Input (Default: "")
[in]ignore_missingGeneric Input (Default: "0")
[in]normalization_optionGeneric Input (Default: "None")
[in]mirroring_optionGeneric Input (Default: "None")
[in]population_optionGeneric Input (Default: "LTE")
[in]lineshapetype_optionGeneric Input (Default: "VP")
[in]cutoff_optionGeneric Input (Default: "None")
[in]cutoff_valueGeneric Input (Default: "750e9")
[in]linemixinglimit_valueGeneric Input (Default: "-1")

Definition at line 326 of file m_absorptionlines.cc.

References ReadARTSCAT(), global_data::species_data, SpeciesTag::TYPE_PLAIN, and SpeciesTag::TYPE_ZEEMAN.

Referenced by ReadSplitARTSCAT_g().

◆ string2hitrantype()

HitranType string2hitrantype ( const String s)

Definition at line 431 of file m_absorptionlines.cc.

References Online, Post2004, and Pre2004.

Referenced by ReadHITRAN().

◆ string2vecqn()

std::vector<QuantumNumberType> string2vecqn ( const String qnstr)

Get a list of quantum numbers from a string.

Parameters
[in]qnstrA string such as "J N v1"
Returns
List of quantum numbers

Definition at line 47 of file m_absorptionlines.cc.

References IsValidQuantumNumberName(), and string2quantumnumbertype().

Referenced by ReadArrayOfARTSCAT(), ReadARTSCAT(), ReadHITRAN(), ReadJPL(), ReadLBLRTM(), and ReadMytran2().