linerecord.h

Go to the documentation of this file.

/* Copyright (C) 2000-2013
   Stefan Buehler <sbuehler@ltu.se>
   Axel von Engeln <engeln@uni-bremen.de>

   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2, or (at your option) any
   later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */

#ifndef linerecord_h
#define linerecord_h

#include <stdexcept>
#include <cmath>
#include "messages.h"
#include "mystring.h"
#include "array.h"
#include "matpackI.h"
#include "quantum.h"

/* Forward declaration of classes */
class SpeciesRecord;
class IsotopologueRecord;

class LineRecord {
public:
    
  LineRecord()
    : mversion (3),
      mspecies (1000000),
      misotopologue (1000000),
      mf       (0.     ),
      mpsf     (0.     ),
      mi0      (0.     ),
      mti0     (0.     ),
      melow    (0.     ),
      magam    (0.     ),
      msgam    (0.     ),
      mnair    (0.     ),
      mnself   (0.     ),
      mtgam    (0.     ),
      maux     (       ),
      mdf      (-1.    ),
      mdi0     (-1.    ),
      mdagam   (-1.    ),
      mdsgam   (-1.    ),
      mdnair   (-1.    ),
      mdnself  (-1.    ),
      mdpsf    (-1.    ),
      mupper_n (-1     ),
      mupper_j (-1     ),
      mlower_n (-1     ),
      mlower_j (-1     ),
      mquantum_numbers_str(""),
      mquantum_numbers()
 { /* Nothing to do here. */ }

  LineRecord( Index                 species,
              Index                 isotopologue,
              Numeric               f,
              Numeric               psf,
              Numeric               i0,
              Numeric               ti0,
              Numeric               elow,
              Numeric               agam,
              Numeric               sgam,
              Numeric               nair,
              Numeric               nself,
              Numeric               tgam,
              const ArrayOfNumeric& aux,
              Numeric               /* df */,
              Numeric               /* di0 */,
              Numeric               /* dagam */,
              Numeric               /* dsgam */,
              Numeric               /* dnair */,
              Numeric               /* dnself */,
              Numeric               /* dpsf */)
    : mversion (3),
      mspecies (species    ),
      misotopologue (isotopologue    ),
      mf       (f          ),
      mpsf     (psf        ),
      mi0      (i0         ),
      mti0     (ti0        ),
      melow    (elow       ),
      magam    (agam       ),
      msgam    (sgam       ),
      mnair    (nair       ),
      mnself   (nself      ),
      mtgam    (tgam       ), 
      maux     (aux        ),
      mdf      (-1.    ),
      mdi0     (-1.    ),
      mdagam   (-1.    ),
      mdsgam   (-1.    ),
      mdnair   (-1.    ),
      mdnself  (-1.    ),
      mdpsf    (-1.    ),
      mupper_n (-1     ),
      mupper_j (-1     ),
      mlower_n (-1     ),
      mlower_j (-1     ),
      mquantum_numbers_str(""),
      mquantum_numbers()
  {
    // Thanks to Matpack, initialization of misotopologue with isotopologue
    // should now work correctly.  

    // Check if this species is legal, i.e., if species and isotopologue
    // data exists.
    //assert( mspecies < species_data.nelem() );
    //assert( misotopologue < species_data[mspecies].Isotopologue().nelem() );
  }

  String VersionString() const;
  
  Index Version() const { return mversion; }
  
  Index Species() const { return mspecies; }

  Index Isotopologue() const { return misotopologue; }

  String Name() const;

  const SpeciesRecord& SpeciesData() const;

  const IsotopologueRecord& IsotopologueData() const;

  Numeric F() const     { return mf; }

  void setF( Numeric new_mf ) { mf = new_mf; }

  Numeric Psf() const   { return mpsf; }

  void setPsf( Numeric new_mpsf ) { mpsf = new_mpsf; }

  Numeric I0() const    { return mi0; }

  void setI0( Numeric new_mi0 ) { mi0 = new_mi0; }

  Numeric Ti0() const   { return mti0; }

  Numeric Elow() const  { return melow; }

  Numeric Agam() const  { return magam; }

  void setAgam( Numeric new_agam ) { magam = new_agam; }

  Numeric Sgam() const  { return msgam; }

  void setSgam( Numeric new_sgam ) { msgam = new_sgam; }

  Numeric Nair() const  { return mnair; }

  void setNair( Numeric new_mnair ) { mnair = new_mnair; }

  Numeric Nself() const { return mnself; }

  void setNself( Numeric new_mnself ) { mnself = new_mnself; }

  Numeric Tgam() const  { return mtgam; }

  Index Naux() const   { return maux.nelem(); }

  const ArrayOfNumeric& Aux() const { return maux; }
  //

  Numeric dF() const  { return mdf; }

  Numeric dI0() const  { return mdi0; }

  Numeric dAgam() const  { return mdagam; }

  Numeric dSgam() const  { return mdsgam; }

  Numeric dNair() const  { return mdnair; }

  Numeric dNself() const { return mdnself; }

  Numeric dPsf() const { return mdpsf; }

  Numeric A() const { return ma; }
  
  Numeric G_upper() const { return mgupper; }
  
  Numeric G_lower() const { return mglower; }
  
  Numeric Gamma_foreign(const Index i) const { return mgamma_foreign[i]; }

   Numeric N_foreign(const Index i) const { return mn_foreign[i]; }

   Numeric Delta_foreign(const Index i) const { return mdelta_foreign[i]; }

//  /** Broadening parameter self in <b> Hz/Pa </b>: */
//  Numeric Gamma_self() const { return mgamma_self; }
//  
//  /** Broadening parameter N2 in <b> Hz/Pa </b>: */
//  Numeric Gamma_N2() const { return mgamma_n2; }
//  
//  /** Broadening parameter O2 in <b> Hz/Pa </b>: */
//  Numeric Gamma_O2() const { return mgamma_o2; }
//  
//  /** Broadening parameter H2O in <b> Hz/Pa </b>: */
//  Numeric Gamma_H2O() const { return mgamma_h2o; }
//  
//  /** Broadening parameter CO2 in <b> Hz/Pa </b>: */
//  Numeric Gamma_CO2() const { return mgamma_co2; }
//  
//  /** Broadening parameter H2 in <b> Hz/Pa </b>: */
//  Numeric Gamma_H2() const { return mgamma_h2; }
//  
//  /** Broadening parameter He in <b> Hz/Pa </b>: */
//  Numeric Gamma_He() const { return mgamma_he; }
//  
//  /** GAM temp. exponent N self: */
//  Numeric Gam_N_self() const { return mn_self; }
//  
//  /** GAM temp. exponent N N2: */
//  Numeric Gam_N_N2() const { return mn_n2; }
//  
//  /** GAM temp. exponent N O2: */
//  Numeric Gam_N_O2() const { return mn_o2; }
//  
//  /** GAM temp. exponent N H2O: */
//  Numeric Gam_N_H2O() const { return mn_h2o; }
//  
//  /** GAM temp. exponent N CO2: */
//  Numeric Gam_N_CO2() const { return mn_co2; }
//  
//  /** GAM temp. exponent N H2: */
//  Numeric Gam_N_H2() const { return mn_h2; }
//  
//  /** GAM temp. exponent N He: */
//  Numeric Gam_N_He() const { return mn_he; }
//  
//  /** F Pressure shift N2 in <b> Hz/Pa </b>: */
//  Numeric Delta_N2() const { return mdelta_n2; }
//  
//  /** F Pressure shift O2 in <b> Hz/Pa </b>: */
//  Numeric Delta_O2() const { return mdelta_o2; }
//  
//  /** F Pressure shift H2O in <b> Hz/Pa </b>: */
//  Numeric Delta_H2O() const { return mdelta_h2o; }
//  
//  /** F Pressure shift CO2 in <b> Hz/Pa </b>: */
//  Numeric Delta_CO2() const { return mdelta_co2; }
//  
//  /** F Pressure shift H2 in <b> Hz/Pa </b>: */
//  Numeric Delta_H2() const { return mdelta_h2; }
//  
//  /** F Pressure shift He in <b> Hz/Pa </b>: */
//  Numeric Delta_He() const { return mdelta_he; }

  const String& Upper_GQuanta() const { return mupper_gquanta; }

  const String& Lower_GQuanta() const { return mlower_gquanta; }

  const String& Upper_LQuanta() const { return mupper_lquanta; }

  const String& Lower_LQuanta() const { return mlower_lquanta; }

  Rational Upper_N() const { return mupper_n; }

  Rational Upper_J() const { return mupper_j; }

  Rational Lower_N() const { return mlower_n; }

  Rational Lower_J() const { return mlower_j; }

  const String& QuantumNumbersString() const { return mquantum_numbers_str; }

  const QuantumNumberRecord& QuantumNumbers() const { return mquantum_numbers; }
    

  enum {
    BROAD_SPEC_POS_N2,
    BROAD_SPEC_POS_O2,
    BROAD_SPEC_POS_H2O,
    BROAD_SPEC_POS_CO2,
    BROAD_SPEC_POS_H2,
    BROAD_SPEC_POS_He
  };

  static Index NBroadSpec()  {return 6;}
    
  static String BroadSpecName(const Index i)  {
    switch (i) {
      case BROAD_SPEC_POS_N2:
        return "N2";
        break;
      case BROAD_SPEC_POS_O2:
        return "O2";
        break;
      case BROAD_SPEC_POS_H2O:
        return "H2O";
        break;
      case BROAD_SPEC_POS_CO2:
        return "CO2";
        break;
      case BROAD_SPEC_POS_H2:
        return "H2";
        break;
      case BROAD_SPEC_POS_He:
        return "He";
        break;
      default:
        assert(false);   // We should never end up here.
        return "";
        break;
    }
  }
  
  static Index BroadSpecSpecIndex(const Index i);

  void ARTSCAT4FromARTSCAT3();
  
  void ARTSCAT4UnusedToNaN() {
      
      // Resize aux array to 0, not used in ARTSCAT-4:
      maux.resize(0);
      
      // Set other parameters to NAN:
      magam    = NAN;
      mnair    = NAN;
      mpsf     = NAN;
      mtgam    = NAN;
      
      mdf      = NAN;
      mdi0     = NAN;
      mdagam   = NAN;
      mdsgam   = NAN;
      mdnair   = NAN;
      mdnself  = NAN;
      mdpsf    = NAN;
    }
  
  bool ReadFromHitran2001Stream(istream& is, const Verbosity& verbosity);



  bool ReadFromHitran2004Stream(istream& is, const Verbosity& verbosity, const Numeric fmin=0);




  bool ReadFromMytran2Stream(istream& is, const Verbosity& verbosity);


  bool ReadFromJplStream(istream& is, const Verbosity& verbosity);

  bool ReadFromArtscat3Stream(istream& is, const Verbosity& verbosity);

  bool ReadFromArtscat4Stream(istream& is, const Verbosity& verbosity);
    
private:
  // Version number:
  Index mversion;
  // Molecular species index: 
  Index mspecies;
  // Isotopologue species index:
  Index misotopologue;
  // The line center frequency in Hz:
  Numeric mf;
  // The pressure shift parameter in Hz/Pa:
  Numeric mpsf;
  // The line intensity in m^2/Hz:
  Numeric mi0;
  // Reference temperature for I0 in K:
  Numeric mti0;
  // Lower state energy in cm^-1:
  Numeric melow;
  // Air broadened width in Hz/Pa:
  Numeric magam;
  // Self broadened width in Hz/Pa:
  Numeric msgam;
  // AGAM temperature exponent (dimensionless):
  Numeric mnair;
  // SGAM temperature exponent (dimensionless):
  Numeric mnself;
  // Reference temperature for AGAM and SGAM in K:
  Numeric mtgam;
  // Array to hold auxiliary parameters:
  ArrayOfNumeric maux;
  //
  // Fields for the spectroscopic parameters accuracies
  //
  // Accuracy for line center frequency in Hz:
  Numeric mdf;
  // Accuracy for line intensity in %:
  Numeric mdi0;
  // Accuracy for air broadened width in %:
  Numeric mdagam;
  // Accuracy for self broadened width in %:
  Numeric mdsgam;
  // Accuracy for AGAM temperature exponent in %:
  Numeric mdnair;
  //  Accuracy for SGAM temperature exponent in %:
  Numeric mdnself;
 //  Accuracy for pressure shift in %:
  Numeric mdpsf;
  
  
  // Einstein A-coefficient in 1/s:
  Numeric ma;
  // Upper state stat. weight:
  Numeric mgupper;
  // Lower state stat. weight:
  Numeric mglower;
  
  // Broadening parameter self in Hz/Pa:
  //  Numeric mgamma_self;
  // Already in artscat-3 as msgam
    
  // Array of foreign broadening parameters in Hz/Pa. Parameters for
  // individual species can be found using the enum defined in this class.
  Vector mgamma_foreign;
  
//  // Broadening parameter N2 in Hz/Pa:
//  Numeric mgamma_n2;
//  // Broadening parameter O2 in Hz/Pa:
//  Numeric mgamma_o2;
//  // Broadening parameter H2O in Hz/Pa:
//  Numeric mgamma_h2o;
//  // Broadening parameter CO2 in Hz/Pa:
//  Numeric mgamma_co2;
//  // Broadening parameter H2 in Hz/Pa:
//  Numeric mgamma_h2;
//  // Broadening parameter He in Hz/Pa:
//  Numeric mgamma_he;

  // GAM temp. exponent self:
  //  Numeric mn_self;
  // Already in artscat-3 as msgam mnself

  // Array of foreign temp. exponents (dimensionless). Parameters for
  // individual species can be found using the enum defined in this class.
  Vector mn_foreign;

//  // GAM temp. exponent N2:
//  Numeric mn_n2;
//  // GAM temp. exponent O2:
//  Numeric mn_o2;
//  // GAM temp. exponent H2O:
//  Numeric mn_h2o;
//  // GAM temp. exponent CO2:
//  Numeric mn_co2;
//  // GAM temp. exponent H2:
//  Numeric mn_h2;
//  // GAM temp. exponent He:
//  Numeric mn_he;
  
  // Array of pressure shift parameters in Hz/Pa. Parameters for
  // individual species can be found using the enum defined in this class.
  Vector mdelta_foreign;

//  // F Pressure shift N2 in Hz/Pa:
//  Numeric mdelta_n2;
//  // F Pressure shift O2 in Hz/Pa:
//  Numeric mdelta_o2;
//  // F Pressure shift H2O in Hz/Pa:
//  Numeric mdelta_h2o;
//  // F Pressure shift CO2 in Hz/Pa:
//  Numeric mdelta_co2;
//  // F Pressure shift H2 in Hz/Pa:
//  Numeric mdelta_h2;
//  // F Pressure shift He in Hz/Pa:
//  Numeric mdelta_he;

  String mupper_gquanta;
  String mlower_gquanta;
  String mupper_lquanta;
  String mlower_lquanta;
  Rational mupper_n;
  Rational mupper_j;
  Rational mlower_n;
  Rational mlower_j;

  String mquantum_numbers_str;

  QuantumNumberRecord mquantum_numbers;
};

ostream& operator<<(ostream& os, const LineRecord& lr);


//======================================================================
//         Typedefs for LineRecord Arrays
//======================================================================

typedef Array<LineRecord> ArrayOfLineRecord;

typedef Array< Array<LineRecord> > ArrayOfArrayOfLineRecord;


//======================================================================
//         Functions for searches inside the line catalog
//======================================================================

typedef enum {
    LINE_MATCH_FIRST,
    LINE_MATCH_UNIQUE,
    LINE_MATCH_ALL
} LineMatchingCriteria;



bool find_matching_lines(ArrayOfIndex& matches,
                         const ArrayOfLineRecord& abs_lines,
                         const Index species,
                         const Index isotopologue,
                         const QuantumNumberRecord qr,
                         const LineMatchingCriteria match_criteria = LINE_MATCH_ALL);

#endif // linerecord_h