ATMRefractiveIndexProfile.h

Go to the documentation of this file.

#ifndef _ATM_REFRACTIVEINDEXPROFILE_H
#define _ATM_REFRACTIVEINDEXPROFILE_H
/*******************************************************************************
 * ALMA - Atacama Large Millimiter Array
 * (c) Instituto de Estructura de la Materia, 2009
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * "@(#) $Id: ATMRefractiveIndexProfile.h Exp $"
 *
 * who       when      what
 * --------  --------  ----------------------------------------------
 * pardo     24/03/09  created
 */

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include "ATMAngle.h"
#include "ATMCommon.h"
#include "ATMInverseLength.h"
#include "ATMOpacity.h"
#include "ATMProfile.h"
#include "ATMSpectralGrid.h"
#include "ATMRefractiveIndex.h"

#include <complex>

ATM_NAMESPACE_BEGIN

class RefractiveIndexProfile: public AtmProfile, public SpectralGrid
{
public:


  RefractiveIndexProfile(const Frequency &frequency,
                         const AtmProfile &atmProfile);

  RefractiveIndexProfile(const SpectralGrid &spectralGrid,
                         const AtmProfile &atmProfile);

  RefractiveIndexProfile(const RefractiveIndexProfile &);

  RefractiveIndexProfile();

  virtual ~RefractiveIndexProfile();



  bool setBasicAtmosphericParameters(const Length &altitude,
                                     const Pressure &groundPressure,
                                     const Temperature &groundTemperature,
                                     double tropoLapseRate,
                                     const Humidity &relativeHumidity,
                                     const Length &wvScaleHeight);


  inline void addNewSpectralWindow(unsigned int numChan,
                                   unsigned int refChan,
                                   const Frequency &refFreq,
                                   const Frequency &chanSep)
  {
    SpectralGrid::add(numChan, refChan, refFreq, chanSep);
    mkRefractiveIndexProfile();
  }
  inline void addNewSpectralWindow(unsigned int numChan,
                                   unsigned int refChan,
                                   double* chanFreq,
                                   const string &freqUnits)
  {
    SpectralGrid::add(numChan, refChan, chanFreq, freqUnits);
    mkRefractiveIndexProfile();
  }
  inline void addNewSpectralWindow(unsigned int numChan,
                                   double refFreq,
                                   double* chanFreq,
                                   const string &freqUnits)
  {
    SpectralGrid::add(numChan, refFreq, chanFreq, freqUnits);
    mkRefractiveIndexProfile();
  }
  inline void addNewSpectralWindow(unsigned int numChan,
                                   double refFreq,
                                   const vector<double> &chanFreq,
                                   const string &freqUnits)
  {
    SpectralGrid::add(numChan, refFreq, chanFreq, freqUnits);
    mkRefractiveIndexProfile();
  }
  inline void addNewSpectralWindow(unsigned int numChan,
                                   unsigned int refChan,
                                   const Frequency &refFreq,
                                   const Frequency &chanSep,
                                   const Frequency &intermediateFreq,
                                   const SidebandSide &sbSide,
                                   const SidebandType &sbType)
  {
    SpectralGrid::add(numChan,
                      refChan,
                      refFreq,
                      chanSep,
                      intermediateFreq,
                      sbSide,
                      sbType);
    mkRefractiveIndexProfile();
  }
  inline void addNewSpectralWindow(const vector<Frequency> &chanFreq)
  {
    SpectralGrid::add(chanFreq);
    mkRefractiveIndexProfile();
  }

  inline unsigned int getNumIndividualFrequencies() const
  {
    return v_chanFreq_.size();
  }

  inline double getFrequency() const
  {
    return getChanFreq(0).get();
  }

  inline double getFrequency(const string &freqUnits) const
  {
    return getChanFreq(0).get(freqUnits);
  }


  InverseLength getAbsH2OLines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_H2OLinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsH2OLines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_H2OLinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsH2OLines(unsigned int spwid,
                               unsigned int nf,
                               unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_H2OLinesPtr_[j]->at(nl))), "m-1");
  }

  InverseLength getAbsH2OCont(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_H2OContPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsH2OCont(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_H2OContPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsH2OCont(unsigned int spwid,
                              unsigned int nf,
                              unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_H2OContPtr_[j]->at(nl))), "m-1");
  }

  InverseLength getAbsO2Lines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_O2LinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsO2Lines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_O2LinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsO2Lines(unsigned int spwid,
                              unsigned int nf,
                              unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_O2LinesPtr_[j]->at(nl))), "m-1");
  }

  InverseLength getAbsDryCont(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_DryContPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsDryCont(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_DryContPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsDryCont(unsigned int spwid,
                              unsigned int nf,
                              unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_DryContPtr_[j]->at(nl))), "m-1");
  }

  InverseLength getAbsO3Lines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_O3LinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsO3Lines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_O3LinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsO3Lines(unsigned int spwid,
                              unsigned int nf,
                              unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_O3LinesPtr_[j]->at(nl))), "m-1");
  }

  InverseLength getAbsCOLines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_COLinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsCOLines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_COLinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsCOLines(unsigned int spwid,
                              unsigned int nf,
                              unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_COLinesPtr_[j]->at(nl))), "m-1");
  }



  InverseLength getAbsN2OLines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_N2OLinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsN2OLines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_N2OLinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsN2OLines(unsigned int spwid,
                               unsigned int nf,
                               unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_N2OLinesPtr_[j]->at(nl))), "m-1");
  }

  InverseLength getAbsNO2Lines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_NO2LinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsNO2Lines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_NO2LinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsNO2Lines(unsigned int spwid,
                               unsigned int nf,
                               unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_NO2LinesPtr_[j]->at(nl))), "m-1");
  }


  InverseLength getAbsSO2Lines(unsigned int nl) const
  {
    return InverseLength(imag((vv_N_SO2LinesPtr_[0]->at(nl))), "m-1");
  }
  InverseLength getAbsSO2Lines(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_SO2LinesPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsSO2Lines(unsigned int spwid,
                               unsigned int nf,
                               unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_SO2LinesPtr_[j]->at(nl))), "m-1");
  }





  InverseLength getAbsTotalDry(unsigned int nl) const
  {
    return getAbsTotalDry(nl, 0);
  }
  InverseLength getAbsTotalDry(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag(
                              vv_N_O2LinesPtr_[nf]->at(nl)
                              + vv_N_DryContPtr_[nf]->at(nl) + vv_N_O3LinesPtr_[nf]->at(nl)
                              + vv_N_COLinesPtr_[nf]->at(nl) + vv_N_N2OLinesPtr_[nf]->at(nl)
                              + vv_N_NO2LinesPtr_[nf]->at(nl) + vv_N_SO2LinesPtr_[nf]->at(nl)), "m-1");
  }
  InverseLength getAbsTotalDry(unsigned int spwid,
                               unsigned int nf,
                               unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag(
                              vv_N_O2LinesPtr_[j]->at(nl)
                              + vv_N_DryContPtr_[j]->at(nl) + vv_N_O3LinesPtr_[j]->at(nl)
                              + vv_N_COLinesPtr_[j]->at(nl) + vv_N_N2OLinesPtr_[j]->at(nl)
                              + vv_N_NO2LinesPtr_[j]->at(nl) + vv_N_SO2LinesPtr_[j]->at(nl)), "m-1");
  }

  InverseLength getAbsTotalWet(unsigned int nl) const
  {
    return getAbsTotalWet(nl, 0);
  }
  InverseLength getAbsTotalWet(unsigned int nf, unsigned int nl) const
  {
    return InverseLength(imag((vv_N_H2OLinesPtr_[nf]->at(nl)
        + vv_N_H2OContPtr_[nf]->at(nl))), "m-1");
  }
  InverseLength getAbsTotalWet(unsigned int spwid,
                               unsigned int nf,
                               unsigned int nl) const
  {
    unsigned int j = v_transfertId_[spwid] + nf;
    return InverseLength(imag((vv_N_H2OLinesPtr_[j]->at(nl)
        + vv_N_H2OContPtr_[j]->at(nl))), "m-1");
  }

  Opacity getAverageO2LinesOpacity(unsigned int spwid);
  Opacity getAverageO3LinesOpacity(unsigned int spwid);
  Opacity getAverageN2OLinesOpacity(unsigned int spwid);
  Opacity getAverageNO2LinesOpacity(unsigned int spwid);
  Opacity getAverageSO2LinesOpacity(unsigned int spwid);
  Opacity getAverageCOLinesOpacity(unsigned int spwid);
  Opacity getAverageDryContOpacity(unsigned int spwid);

  Opacity getDryOpacity(){return getDryOpacity(0);}
  Opacity getDryOpacityUpTo(Length refalti){return getDryOpacityUpTo(0,refalti);}
  Opacity getDryOpacity(unsigned int nc);
  Opacity getDryOpacityUpTo(unsigned int nc, Length refalti);
  Opacity getDryOpacity(unsigned int spwid, unsigned int nc){ if(!spwidAndIndexAreValid(spwid, nc)) return Opacity(-999.0); return getDryOpacity(v_transfertId_[spwid] + nc);}
  Opacity getDryOpacityUpTo(unsigned int spwid, unsigned int nc, Length refalti)
  {
    if(!spwidAndIndexAreValid(spwid, nc))return Opacity(-999.0);
    return getDryOpacityUpTo(v_transfertId_[spwid] + nc, refalti);
  }
  Opacity getAverageDryOpacity(unsigned int spwid);

  Opacity getDryContOpacity();
  Opacity getDryContOpacity(unsigned int nc);
  Opacity getDryContOpacity(unsigned int spwid, unsigned int nc);
  Opacity getO2LinesOpacity();
  Opacity getO2LinesOpacity(unsigned int nc);
  Opacity getO2LinesOpacity(unsigned int spwid, unsigned int nc);
  Opacity getO3LinesOpacity();
  Opacity getO3LinesOpacity(unsigned int nc);
  Opacity getO3LinesOpacity(unsigned int spwid, unsigned int nc);
  Opacity getCOLinesOpacity();
  Opacity getCOLinesOpacity(unsigned int nc);
  Opacity getCOLinesOpacity(unsigned int spwid, unsigned int nc);
  Opacity getN2OLinesOpacity();
  Opacity getN2OLinesOpacity(unsigned int nc);
  Opacity getN2OLinesOpacity(unsigned int spwid, unsigned int nc);
  Opacity getNO2LinesOpacity();
  Opacity getNO2LinesOpacity(unsigned int nc);
  Opacity getNO2LinesOpacity(unsigned int spwid, unsigned int nc);
  Opacity getSO2LinesOpacity();
  Opacity getSO2LinesOpacity(unsigned int nc);
  Opacity getSO2LinesOpacity(unsigned int spwid, unsigned int nc);

  Opacity getWetOpacity() {return getWetOpacity(getGroundWH2O());}
  Opacity getWetOpacity(const Length &integratedwatercolumn);
  Opacity getWetOpacity(const Length &integratedwatercolumn, unsigned int nc);
  Opacity getWetOpacity(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);
  Opacity getH2OLinesOpacity() {return getH2OLinesOpacity(getGroundWH2O());}
  Opacity getH2OLinesOpacity(const Length &integratedwatercolumn);
  Opacity getH2OLinesOpacity(const Length &integratedwatercolumn, unsigned int nc);
  Opacity getH2OLinesOpacity(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);
  Opacity getH2OContOpacity() {return getH2OContOpacity(getGroundWH2O());}
  Opacity getH2OContOpacity(const Length &integratedwatercolumn);
  Opacity getH2OContOpacity(const Length &integratedwatercolumn, unsigned int nc);
  Opacity getH2OContOpacity(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);





  Opacity getAverageWetOpacity(const Length &integratedwatercolumn, unsigned int spwid);
  Opacity getAverageH2OLinesOpacity(const Length &integratedwatercolumn, unsigned int spwid);
  Opacity getAverageH2OContOpacity(const Length &integratedwatercolumn, unsigned int spwid);

  Angle getNonDispersiveDryPhaseDelay();
  Length getNonDispersiveDryPathLength();
  Angle getNonDispersiveDryPhaseDelay(unsigned int nc);
  Length getNonDispersiveDryPathLength(unsigned int nc);
  Angle getNonDispersiveDryPhaseDelay(unsigned int spwid, unsigned int nc);
  Length getNonDispersiveDryPathLength(unsigned int spwid, unsigned int nc);

  Angle getDispersiveDryPhaseDelay();
  Length getDispersiveDryPathLength();
  Angle getDispersiveDryPhaseDelay(unsigned int nc);
  Length getDispersiveDryPathLength(unsigned int nc);
  Angle getDispersiveDryPhaseDelay(unsigned int spwid, unsigned int nc);
  Length getDispersiveDryPathLength(unsigned int spwid, unsigned int nc);

  Length getAverageNonDispersiveDryPathLength(unsigned int spwid);
  Length getAverageDispersiveDryPathLength(unsigned int spwid);
  Angle getAverageNonDispersiveDryPhaseDelay(unsigned int spwid);
  Angle getAverageDispersiveDryPhaseDelay(unsigned int spwid);

  Angle getO2LinesPhaseDelay();
  Length getO2LinesPathLength();
  Angle getO2LinesPhaseDelay(unsigned int nc);
  Length getO2LinesPathLength(unsigned int nc);
  Angle getO2LinesPhaseDelay(unsigned int spwid, unsigned int nc);
  Angle getAverageO2LinesPhaseDelay(unsigned int spwid);
  Length getO2LinesPathLength(unsigned int spwid, unsigned int nc);
  Length getAverageO2LinesPathLength(unsigned int spwid);

  Angle getO3LinesPhaseDelay();
  Length getO3LinesPathLength();
  Angle getO3LinesPhaseDelay(unsigned int nc);
  Length getO3LinesPathLength(unsigned int nc);
  Angle getO3LinesPhaseDelay(unsigned int spwid, unsigned int nc);
  Angle getAverageO3LinesPhaseDelay(unsigned int spwid);
  Length getO3LinesPathLength(unsigned int spwid, unsigned int nc);
  Length getAverageO3LinesPathLength(unsigned int spwid);

  Angle getCOLinesPhaseDelay();
  Length getCOLinesPathLength();
  Angle getCOLinesPhaseDelay(unsigned int nc);
  Length getCOLinesPathLength(unsigned int nc);
  Angle getCOLinesPhaseDelay(unsigned int spwid, unsigned int nc);
  Angle getAverageCOLinesPhaseDelay(unsigned int spwid);
  Length getCOLinesPathLength(unsigned int spwid, unsigned int nc);
  Length getAverageCOLinesPathLength(unsigned int spwid);




  Angle getN2OLinesPhaseDelay();
  Length getN2OLinesPathLength();
  Angle getN2OLinesPhaseDelay(unsigned int nc);
  Length getN2OLinesPathLength(unsigned int nc);
  Angle getN2OLinesPhaseDelay(unsigned int spwid, unsigned int nc);
  Angle getAverageN2OLinesPhaseDelay(unsigned int spwid);
  Length getN2OLinesPathLength(unsigned int spwid, unsigned int nc);
  Length getAverageN2OLinesPathLength(unsigned int spwid);



  Angle getNO2LinesPhaseDelay();
  Length getNO2LinesPathLength();
  Angle getNO2LinesPhaseDelay(unsigned int nc);
  Length getNO2LinesPathLength(unsigned int nc);
  Angle getNO2LinesPhaseDelay(unsigned int spwid, unsigned int nc);
  Angle getAverageNO2LinesPhaseDelay(unsigned int spwid);
  Length getNO2LinesPathLength(unsigned int spwid, unsigned int nc);
  Length getAverageNO2LinesPathLength(unsigned int spwid);


  Angle getSO2LinesPhaseDelay();
  Length getSO2LinesPathLength();
  Angle getSO2LinesPhaseDelay(unsigned int nc);
  Length getSO2LinesPathLength(unsigned int nc);
  Angle getSO2LinesPhaseDelay(unsigned int spwid, unsigned int nc);
  Angle getAverageSO2LinesPhaseDelay(unsigned int spwid);
  Length getSO2LinesPathLength(unsigned int spwid, unsigned int nc);
  Length getAverageSO2LinesPathLength(unsigned int spwid);









  Angle getDispersiveH2OPhaseDelay() {return getDispersiveH2OPhaseDelay(getGroundWH2O());}
  Angle getDispersiveH2OPhaseDelay(const Length &integratedwatercolumn);
  Length getDispersiveH2OPathLength() {return getDispersiveH2OPathLength(getGroundWH2O());}
  Length getDispersiveH2OPathLength(const Length &integratedwatercolumn);
  Angle getDispersiveH2OPhaseDelay(const Length &integratedwatercolumn, unsigned int nc);
  Length getDispersiveH2OPathLength(const Length &integratedwatercolumn, unsigned int nc);
  Angle getDispersiveH2OPhaseDelay(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);
  Angle getAverageDispersiveH2OPhaseDelay(const Length &integratedwatercolumn, unsigned int spwid);
  Length getDispersiveH2OPathLength(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);
  Length getAverageDispersiveH2OPathLength(const Length &integratedwatercolumn, unsigned int spwid);
  Angle getNonDispersiveH2OPhaseDelay() {return getNonDispersiveH2OPhaseDelay(getGroundWH2O());}
  Angle getNonDispersiveH2OPhaseDelay(const Length &integratedwatercolumn);
  Length getNonDispersiveH2OPathLength() {return getNonDispersiveH2OPathLength(getGroundWH2O());}
  Length getNonDispersiveH2OPathLength(const Length &integratedwatercolumn);
  Angle getNonDispersiveH2OPhaseDelay(const Length &integratedwatercolumn, unsigned int nc);
  Length getNonDispersiveH2OPathLength(const Length &integratedwatercolumn, unsigned int nc);
  Angle getNonDispersiveH2OPhaseDelay(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);
  Length getAverageNonDispersiveH2OPathLength(const Length &integratedwatercolumn, unsigned int spwid);
  Angle getAverageNonDispersiveH2OPhaseDelay(const Length &integratedwatercolumn, unsigned int spwid);
  Length getNonDispersiveH2OPathLength(const Length &integratedwatercolumn, unsigned int spwid, unsigned int nc);

  void updateNewSpectralWindows();


protected:

  vector<vector<std::complex<double> >*> vv_N_H2OLinesPtr_; 
  vector<vector<std::complex<double> >*> vv_N_H2OContPtr_; 
  vector<vector<std::complex<double> >*> vv_N_O2LinesPtr_; 
  vector<vector<std::complex<double> >*> vv_N_DryContPtr_; 
  vector<vector<std::complex<double> >*> vv_N_O3LinesPtr_; 
  vector<vector<std::complex<double> >*> vv_N_COLinesPtr_; 
  vector<vector<std::complex<double> >*> vv_N_N2OLinesPtr_; 
  vector<vector<std::complex<double> >*> vv_N_NO2LinesPtr_; 
  vector<vector<std::complex<double> >*> vv_N_SO2LinesPtr_; 

  /* vecteur de vecteurs ???? */

  void mkRefractiveIndexProfile(); 
  void rmRefractiveIndexProfile(); 

  bool updateRefractiveIndexProfile(const Length &altitude,
                                    const Pressure &groundPressure,
                                    const Temperature &groundTemperature,
                                    double tropoLapseRate,
                                    const Humidity &relativeHumidity,
                                    const Length &wvScaleHeight);

  bool chanIndexIsValid(unsigned int nc);
  bool spwidAndIndexAreValid(unsigned int spwid, unsigned int idx);
}; // class RefractiveIndexProfile

ATM_NAMESPACE_END

#endif