TropCorrector.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk 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 3.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
 
#ifndef GNSSTK_TROPCORRECTOR_HPP
#define GNSSTK_TROPCORRECTOR_HPP
 
#include "GroupPathCorrector.hpp"
#include "SimpleTropModel.hpp"
#include "SaasTropModel.hpp"
#include "NBTropModel.hpp"
#include "GGTropModel.hpp"
#include "GGHeightTropModel.hpp"
#include "NeillTropModel.hpp"
#include "GlobalTropModel.hpp"
#include "MetReader.hpp"
#include "YDSTime.hpp"
 
// forward declaration of test class
class GroupPathCorr_T;
 
namespace gnsstk
{
 
 
   template <class Model>
   class TropCorrector : public GroupPathCorrector
   {
   public:
      TropCorrector();
      bool getCorr(const Position& rxPos, const Position& svPos,
                   const SatID& sat, const ObsID& obs,
                   const CommonTime& when, NavType nav,
                   double& corrOut) override;
      bool getCorr(const Position& rxPos, const Xvt& svPos,
                   const SatID& sat, const ObsID& obs,
                   const CommonTime& when, NavType nav,
                   double& corrOut) override;
      virtual void setDefaultWx(double temp=20, double pres=1013,
                                double hum=50);
      virtual bool loadFile(const std::string& fn);
      MetReader wxData;
   protected:
      bool useDefault;
      double defTemp; 
      double defPres; 
      double defHum;  
 
      virtual void setWeather(Model& model, const CommonTime& when);
 
         // For testing.  Tried adding a const ref accessor, but SWIG
         // complained about it.  This is the easier solution.
      friend class ::GroupPathCorr_T;
   }; // class TropCorrector
 
 
   typedef TropCorrector<ZeroTropModel> ZeroTropCorrector;
   typedef TropCorrector<SimpleTropModel> SimpleTropCorrector;
   typedef TropCorrector<SaasTropModel> SaasTropCorrector;
   typedef TropCorrector<NBTropModel> NBTropCorrector;
   typedef TropCorrector<GGTropModel> GGTropCorrector;
   typedef TropCorrector<GGHeightTropModel> GGHeightTropCorrector;
   typedef TropCorrector<NeillTropModel> NeillTropCorrector;
   typedef TropCorrector<GlobalTropModel> GlobalTropCorrector;
 
 
   template <class Model>
   TropCorrector<Model> ::
   TropCorrector()
         : useDefault(false),
           defTemp(std::numeric_limits<double>::quiet_NaN()),
           defPres(std::numeric_limits<double>::quiet_NaN()),
           defHum(std::numeric_limits<double>::quiet_NaN())
   {
      corrType = CorrectorType::Trop;
   }
 
 
   template <class Model>
   bool TropCorrector<Model> ::
   getCorr(const Position& rxPos, const Position& svPos,
           const SatID& sat, const ObsID& obs,
           const CommonTime& when, NavType nav,
           double& corrOut)
   {
      Model model;
      model.setReceiverHeight(rxPos.height());
      model.setReceiverLatitude(rxPos.getGeodeticLatitude());
      model.setReceiverLongitude(rxPos.getLongitude());
      model.setDayOfYear(YDSTime(when).doy);
      try
      {
         setWeather(model, when);
         corrOut = model.correction(rxPos, svPos, when);
         return true;
      }
      catch (...)
      {
         corrOut = std::numeric_limits<double>::quiet_NaN();
         return false;
      }
   }
 
 
   template <class Model>
   bool TropCorrector<Model> ::
   getCorr(const Position& rxPos, const Xvt& svPos,
           const SatID& sat, const ObsID& obs,
           const CommonTime& when, NavType nav,
           double& corrOut)
   {
      Position svp(svPos.x);
      return getCorr(rxPos, svp, sat, obs, when, nav, corrOut);
   }
 
 
   template <class Model>
   void TropCorrector<Model> ::
   setDefaultWx(double temp, double pres, double hum)
   {
      useDefault = true;
      defTemp = temp;
      defPres = pres;
      defHum = hum;
   }
 
 
   template <class Model>
   bool TropCorrector<Model> ::
   loadFile(const std::string& fn)
   {
      useDefault = false;
      wxData.read(fn);
      return true;
   }
 
 
   template <class Model>
   void TropCorrector<Model> ::
   setWeather(Model& model, const CommonTime& when)
   {
      if (!useDefault)
      {
         model.setWeather(wxData.wx.getWxObservation(when));
      }
      else
      {
         model.setWeather(defTemp, defPres, defHum);
      }
   }
 
 
   template <>
   inline void TropCorrector<NBTropModel> ::
   setWeather(NBTropModel& model, const CommonTime& when)
   {
      if (!useDefault)
      {
         if (wxData.wx.obs.empty())
         {
               // Haven't used the default weather via
               // setDefaultWx() and if loadFile was called, it was
               // unsuccessful.  Maybe using the New Brunswick
               // special case, so try that.
            model.setWeather();
         }
         else
         {
            model.setWeather(wxData.wx.getWxObservation(when));
         }
      }
      else
      {
         model.setWeather(defTemp, defPres, defHum);
      }
   }
 
} // namespace gnsstk
 
#endif // GNSSTK_TROPCORRECTOR_HPP