Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
gnsstk::TropCorrector< Model > Class Template Reference

Detailed Description

template<class Model>
class gnsstk::TropCorrector< Model >

Provide a means for estimating the pseudorange delay due to tropospheric conditions. To use it, instantiate one of the typedefs, then call one of either setDefaultWx() or loadFile() (the most recently called will be used to set the model's weather data). At that point, the getCorr() methods may be used.

double corr;
if (!trop.loadFile("arlm2000.15m"))
return false;
if (!trop.getCorr(stnPos, svPos, sat, obsID, when, nav, corr))
return false;
cout << "trop delay: " << corr << " m" << endl;
Note
The NBTropModel::setWeather() approach (calling with no arguments so that the data may be modeled using latitude and time) can be used by simply not calling setDefaultWx() or loadFile() either one. This approach is unique to NBTropModel. All other models will indicate an error condition if no weather data is loaded.
Parameters
ModelThe tropospheric model class, which is expected to be derived from the TropModel class. Since there is a relatively limited number of these, there are typedefs for each of the existing TropModel classes.

Definition at line 90 of file TropCorrector.hpp.

#include <TropCorrector.hpp>

Inheritance diagram for gnsstk::TropCorrector< Model >:
Inheritance graph
[legend]

Public Member Functions

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 bool loadFile (const std::string &fn)
 Load RINEX MET data into wxData, uses Model. More...
 
virtual void setDefaultWx (double temp=20, double pres=1013, double hum=50)
 
 TropCorrector ()
 Set the corrType to Trop for GroupPathCorr. More...
 
- Public Member Functions inherited from gnsstk::GroupPathCorrector
 GroupPathCorrector ()
 Set the corrType to Unknown by default. More...
 

Public Attributes

MetReader wxData
 Read and store weather data for look-up (single site) More...
 
- Public Attributes inherited from gnsstk::GroupPathCorrector
CorrectorType corrType
 Set by child classes, indicates what type of bias is computed. More...
 

Protected Member Functions

virtual void setWeather (Model &model, const CommonTime &when)
 
void setWeather (NBTropModel &model, const CommonTime &when)
 Template specialization for NBTropModel. More...
 

Protected Attributes

double defHum
 Default humidity (%). More...
 
double defPres
 Default pressure value (millibars). More...
 
double defTemp
 Default temperature value (degrees C). More...
 
bool useDefault
 Set to true if setDefaultWx was called more recently than loadFile. More...
 

Friends

class ::GroupPathCorr_T
 

Constructor & Destructor Documentation

◆ TropCorrector()

template<class Model >
gnsstk::TropCorrector< Model >::TropCorrector

Set the corrType to Trop for GroupPathCorr.

Definition at line 155 of file TropCorrector.hpp.

Member Function Documentation

◆ getCorr() [1/2]

template<class Model >
bool gnsstk::TropCorrector< Model >::getCorr ( const Position rxPos,
const Position svPos,
const SatID sat,
const ObsID obs,
const CommonTime when,
NavType  nav,
double &  corrOut 
)
overridevirtual

Get the bias in meters given the supplied state arguments.

Parameters
[in]rxPosThe position of the GNSS receiver antenna.
[in]svPosThe position of the satellite with delayed signal.
[in]satThe identity of the satellite with delayed signal.
[in]obsThe ID of the signal being un-delayed.
[in]whenThe time of measurement.
[in]navThe navigation message type of the signal.
[out]corrOutThe computed bias in meters.
Returns
true if successful, false on error.

Implements gnsstk::GroupPathCorrector.

Definition at line 167 of file TropCorrector.hpp.

◆ getCorr() [2/2]

template<class Model >
bool gnsstk::TropCorrector< Model >::getCorr ( const Position rxPos,
const Xvt svPos,
const SatID sat,
const ObsID obs,
const CommonTime when,
NavType  nav,
double &  corrOut 
)
overridevirtual

Get the bias in meters given the supplied state arguments.

Parameters
[in]rxPosThe position of the GNSS receiver antenna.
[in]svPosThe position of the satellite with delayed signal.
[in]satThe identity of the satellite with delayed signal.
[in]obsThe ID of the signal being un-delayed.
[in]whenThe time of measurement.
[in]navThe navigation message type of the signal.
[out]corrOutThe computed bias in meters.
Returns
true if successful, false on error.

Implements gnsstk::GroupPathCorrector.

Definition at line 193 of file TropCorrector.hpp.

◆ loadFile()

template<class Model >
bool gnsstk::TropCorrector< Model >::loadFile ( const std::string &  fn)
virtual

Load RINEX MET data into wxData, uses Model.

Definition at line 216 of file TropCorrector.hpp.

◆ setDefaultWx()

template<class Model >
void gnsstk::TropCorrector< Model >::setDefaultWx ( double  temp = 20,
double  pres = 1013,
double  hum = 50 
)
virtual

Set default weather data if no time series is available

Parameters
[in]tempThe new default temperature (degrees C).
[in]presThe new default pressure (millibars).
[in]humThe new default humidity (%).

Definition at line 205 of file TropCorrector.hpp.

◆ setWeather() [1/2]

template<class Model >
void gnsstk::TropCorrector< Model >::setWeather ( Model &  model,
const CommonTime when 
)
protectedvirtual

Tell the model what weather to use.

Parameters
[in,out]modelThe model whose weather data is to be set.
[in]whenThe time of the GNSS observation.
Postcondition
The weather data for model is set.

Definition at line 226 of file TropCorrector.hpp.

◆ setWeather() [2/2]

void gnsstk::TropCorrector< NBTropModel >::setWeather ( NBTropModel model,
const CommonTime when 
)
inlineprotected

Template specialization for NBTropModel.

Definition at line 242 of file TropCorrector.hpp.

Friends And Related Function Documentation

◆ ::GroupPathCorr_T

template<class Model >
friend class ::GroupPathCorr_T
friend

Definition at line 130 of file TropCorrector.hpp.

Member Data Documentation

◆ defHum

template<class Model >
double gnsstk::TropCorrector< Model >::defHum
protected

Default humidity (%).

Definition at line 120 of file TropCorrector.hpp.

◆ defPres

template<class Model >
double gnsstk::TropCorrector< Model >::defPres
protected

Default pressure value (millibars).

Definition at line 119 of file TropCorrector.hpp.

◆ defTemp

template<class Model >
double gnsstk::TropCorrector< Model >::defTemp
protected

Default temperature value (degrees C).

Definition at line 118 of file TropCorrector.hpp.

◆ useDefault

template<class Model >
bool gnsstk::TropCorrector< Model >::useDefault
protected

Set to true if setDefaultWx was called more recently than loadFile.

Definition at line 117 of file TropCorrector.hpp.

◆ wxData

template<class Model >
MetReader gnsstk::TropCorrector< Model >::wxData

Read and store weather data for look-up (single site)

Definition at line 114 of file TropCorrector.hpp.


The documentation for this class was generated from the following file:
gnsstk::TropCorrector
Definition: TropCorrector.hpp:90
gnsstk::TropCorrector::loadFile
virtual bool loadFile(const std::string &fn)
Load RINEX MET data into wxData, uses Model.
Definition: TropCorrector.hpp:216
gnsstk::TropCorrector::getCorr
bool getCorr(const Position &rxPos, const Position &svPos, const SatID &sat, const ObsID &obs, const CommonTime &when, NavType nav, double &corrOut) override
Definition: TropCorrector.hpp:167


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:46