Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples | Search for 

CorrectObservables Class Reference
[GPSTk data structures]

#include <CorrectObservables.hpp>

Inheritance diagram for CorrectObservables:

Inheritance graph
[legend]
Collaboration diagram for CorrectObservables:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class corrects observables from effects such as antenna excentricity, difference in phase centers, offsets due to tidal effects, etc.

This class is meant to be used with the GNSS data structures objects found in "DataStructures" class.

A typical way to use this class follows:

       // Create the input obs file stream
    RinexObsStream rin("ebre0300.02o");

       // Loads precise ephemeris object with file data
    SP3EphemerisStore SP3EphList;
    SP3EphList.loadFile("igs11513.sp3");

       // Sets nominal position of receiver
    Position nominalPos(4833520.3800, 41536.8300, 4147461.2800);

       // Vector from antenna ARP to L1 phase center [UEN](Leica AT504)
    Triple offsetL1(0.1093, -0.0003, 0.0003);        // Units in meters

       // Vector from antenna ARP to L2 phase center [UEN](Leica AT504)
    Triple offsetL2(0.1282, 0.0011, 0.0011);         // Units in meters

       // Vector from monument to antenna ARP [UEN] for this station
    Triple offsetARP(2.510, 0.300, 1.045);           // Units in meters

       // Vector due to tidal effects (previously computed)
    Triple tides(0.121, 0.033, -0.016);              // Units in meters


   gnssRinex gRin;
   CorrectObservables corr( SP3EphList,
                            nominalPos,
                            offsetL1,
                            offsetL2,
                            offsetARP,
                            tides       );

   while(rin >> gRin)
   {
      gRin >> corr;
   }

The "CorrectObservables" object will visit every satellite in the GNSS data structure that is "gRin" and will correct the corresponding observables from the given effects.

When used with the ">>" operator, this class returns the same incoming data structure with the observables corrected. Be warned that if a given satellite does not have the observations required, it will be summarily deleted from the data structure.

Definition at line 110 of file CorrectObservables.hpp.

Public Member Functions

 CorrectObservables ()
 Default constructor.
 CorrectObservables (XvtStore< SatID > &ephem)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos, const Antenna &antennaObj)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos, const Triple &L1pc)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos, const Triple &L1pc, const Triple &L2pc)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos, const Triple &L1pc, const Triple &L2pc, const Triple &extra)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos, const Triple &L1pc, const Triple &L2pc, const Triple &monument, const Triple &extra)
 Common constructor.
 CorrectObservables (XvtStore< SatID > &ephem, const Position &stapos, const Triple &L1pc, const Triple &L2pc, const Triple &L5pc, const Triple &L6pc, const Triple &L7pc, const Triple &L8pc, const Triple &monument, const Triple &extra)
 Common constructor.
virtual satTypeValueMap & Process (const DayTime &time, satTypeValueMap &gData) throw (ProcessingException)
 Returns a satTypeValueMap object, adding the new data generated when calling this object.
virtual gnssSatTypeValue & Process (gnssSatTypeValue &gData) throw (ProcessingException)
 Returns a gnnsSatTypeValue object, adding the new data generated when calling this object.
virtual gnssRinex & Process (gnssRinex &gData) throw (ProcessingException)
 Returns a gnnsRinex object, adding the new data generated when calling this object.
virtual Position getNominalPosition (void) const
 Returns nominal position of receiver station.
virtual CorrectObservables & setNominalPosition (const Position &stapos)
 Sets nominal position of receiver station.
virtual XvtStore< SatID > * getEphemeris (void) const
 Returns a pointer to the satellite ephemeris object currently in use.
virtual CorrectObservables & setEphemeris (XvtStore< SatID > &ephem)
 Sets satellite ephemeris object to be used.
virtual Triple getL1pc (void) const
 Returns position of antenna L1 phase center with respect to ARP ([UEN]).
virtual CorrectObservables & setL1pc (const Triple &L1pc)
 Sets position of antenna L1 phase center with respect to ARP ([UEN]).
virtual Triple getL2pc (void) const
 Returns position of antenna L2 phase center with respect to ARP ([UEN]).
virtual CorrectObservables & setL2pc (const Triple &L2pc)
 Sets position of antenna L2 phase center with respect to ARP ([UEN]).
virtual Triple getL5pc (void) const
 Returns position of antenna L5 phase center with respect to ARP ([UEN]).
virtual CorrectObservables & setL5pc (const Triple &L5pc)
 Sets position of antenna L5 phase center with respect to ARP ([UEN]).
virtual Triple getL6pc (void) const
 Returns position of antenna L6 phase center with respect to ARP ([UEN]).
virtual CorrectObservables & setL6pc (const Triple &L6pc)
 Sets position of antenna L6 phase center with respect to ARP ([UEN]).
virtual Triple getL7pc (void) const
 Returns position of antenna L7 phase center with respect to ARP ([UEN]).
virtual CorrectObservables & setL7pc (const Triple &L7pc)
 Sets position of antenna L7 phase center with respect to ARP ([UEN]).
virtual Triple getL8pc (void) const
 Returns position of antenna L8 phase center with respect to ARP ([UEN]).
virtual CorrectObservables & setL8pc (const Triple &L8pc)
 Sets position of antenna L8 phase center with respect to ARP ([UEN]).
virtual Triple getMonument (void) const
 Returns vector from monument to ARP ([UEN]).
virtual CorrectObservables & setMonument (const Triple &monument)
 Sets vector from monument to ARP ([UEN]).
virtual Triple getExtraBiases (void) const
 Returns extra biases affecting monument, such as tidal effects ([UEN]).
virtual CorrectObservables & setExtraBiases (const Triple &extra)
 Sets extra biases affecting monument, such as tidal effects ([UEN]).
virtual Antenna getAntenna (void) const
 Returns the antenna object being used.
virtual CorrectObservables & setAntenna (const Antenna &antennaObj)
 Sets the antenna object to be used.
virtual bool getUseAzimuth (void) const
 Returns whether azimuth-dependent antenna patterns are being used.
virtual CorrectObservables & setUseAzimuth (bool useAzimuthPattern)
 Sets whether azimuth-dependent antenna patterns will be used.
virtual int getIndex (void) const
 Returns an index identifying this object.
virtual std::string getClassName (void) const
 Returns a string identifying this object.
virtual ~CorrectObservables ()
 Destructor.

Constructor & Destructor Documentation

CorrectObservables (   )  [inline]
 

Default constructor.

Definition at line 115 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem  )  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.

Definition at line 129 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.

Definition at line 144 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos,
const Antenna &  antennaObj
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
antennaObj Antenna object with information taken from Antex file.

Definition at line 162 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos,
const Triple &  L1pc
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
L1pc Position of antenna L1 phase center with respect to ARP ([UEN]).

Definition at line 182 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos,
const Triple &  L1pc,
const Triple &  L2pc
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
L1pc Position of antenna L1 phase center with respect to ARP ([UEN]).
L2pc Position of antenna L2 phase center with respect to ARP ([UEN]).

Definition at line 203 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos,
const Triple &  L1pc,
const Triple &  L2pc,
const Triple &  extra
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
L1pc Position of antenna L1 phase center with respect to ARP ([UEN]).
L2pc Position of antenna L2 phase center with respect to ARP ([UEN]).
extra Extra biases affecting monument, such as tidal effects ([UEN]).

Definition at line 227 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos,
const Triple &  L1pc,
const Triple &  L2pc,
const Triple &  monument,
const Triple &  extra
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
L1pc Position of antenna L1 phase center with respect to ARP ([UEN]).
L2pc Position of antenna L2 phase center with respect to ARP ([UEN]).
monument Vector from monument to ARP ([UEN]).
extra Extra biases affecting monument, such as tidal effects ([UEN]).

Definition at line 253 of file CorrectObservables.hpp.

CorrectObservables (  XvtStore< SatID > &  ephem,
const Position &  stapos,
const Triple &  L1pc,
const Triple &  L2pc,
const Triple &  L5pc,
const Triple &  L6pc,
const Triple &  L7pc,
const Triple &  L8pc,
const Triple &  monument,
const Triple &  extra
)  [inline]
 

Common constructor.

Parameters:
ephem Satellite ephemeris.
stapos Nominal position of receiver station.
L1pc Position of antenna L1 phase center with respect to ARP ([UEN]).
L2pc Position of antenna L2 phase center with respect to ARP ([UEN]).
L5pc Position of antenna L5 phase center with respect to ARP ([UEN]).
L6pc Position of antenna L6 phase center with respect to ARP ([UEN]).
L7pc Position of antenna L7 phase center with respect to ARP ([UEN]).
L8pc Position of antenna L8 phase center with respect to ARP ([UEN]).
monument Vector from monument to ARP ([UEN]).
extra Extra biases affecting monument, such as tidal effects ([UEN]).

Definition at line 288 of file CorrectObservables.hpp.

virtual ~CorrectObservables (   )  [inline, virtual]
 

Destructor.

Definition at line 528 of file CorrectObservables.hpp.

Member Function Documentation

virtual Antenna getAntenna (  void   )  const [inline, virtual]
 

Returns the antenna object being used.

Definition at line 493 of file CorrectObservables.hpp.

std::string getClassName (  void   )  const [virtual]
 

Returns a string identifying this object.

Implements ProcessingClass.

Definition at line 48 of file CorrectObservables.cpp.

virtual XvtStore<SatID>* getEphemeris (  void   )  const [inline, virtual]
 

Returns a pointer to the satellite ephemeris object currently in use.

Definition at line 353 of file CorrectObservables.hpp.

virtual Triple getExtraBiases (  void   )  const [inline, virtual]
 

Returns extra biases affecting monument, such as tidal effects ([UEN]).

Definition at line 478 of file CorrectObservables.hpp.

int getIndex (  void   )  const [virtual]
 

Returns an index identifying this object.

Implements ProcessingClass.

Definition at line 43 of file CorrectObservables.cpp.

virtual Triple getL1pc (  void   )  const [inline, virtual]
 

Returns position of antenna L1 phase center with respect to ARP ([UEN]).

Definition at line 368 of file CorrectObservables.hpp.

virtual Triple getL2pc (  void   )  const [inline, virtual]
 

Returns position of antenna L2 phase center with respect to ARP ([UEN]).

Definition at line 384 of file CorrectObservables.hpp.

virtual Triple getL5pc (  void   )  const [inline, virtual]
 

Returns position of antenna L5 phase center with respect to ARP ([UEN]).

Definition at line 400 of file CorrectObservables.hpp.

virtual Triple getL6pc (  void   )  const [inline, virtual]
 

Returns position of antenna L6 phase center with respect to ARP ([UEN]).

Definition at line 416 of file CorrectObservables.hpp.

virtual Triple getL7pc (  void   )  const [inline, virtual]
 

Returns position of antenna L7 phase center with respect to ARP ([UEN]).

Definition at line 432 of file CorrectObservables.hpp.

virtual Triple getL8pc (  void   )  const [inline, virtual]
 

Returns position of antenna L8 phase center with respect to ARP ([UEN]).

Definition at line 448 of file CorrectObservables.hpp.

virtual Triple getMonument (  void   )  const [inline, virtual]
 

Returns vector from monument to ARP ([UEN]).

Definition at line 463 of file CorrectObservables.hpp.

virtual Position getNominalPosition (  void   )  const [inline, virtual]
 

Returns nominal position of receiver station.

Definition at line 338 of file CorrectObservables.hpp.

virtual bool getUseAzimuth (  void   )  const [inline, virtual]
 

Returns whether azimuth-dependent antenna patterns are being used.

When an Antenna is set, this parameter is true by default.

Definition at line 507 of file CorrectObservables.hpp.

virtual gnssRinex& Process (  gnssRinex &  gData  )  throw (ProcessingException) [inline, virtual]
 

Returns a gnnsRinex object, adding the new data generated when calling this object.

Parameters:
gData Data object holding the data.

Implements ProcessingClass.

Definition at line 332 of file CorrectObservables.hpp.

virtual gnssSatTypeValue& Process (  gnssSatTypeValue &  gData  )  throw (ProcessingException) [inline, virtual]
 

Returns a gnnsSatTypeValue object, adding the new data generated when calling this object.

Parameters:
gData Data object holding the data.

Implements ProcessingClass.

Definition at line 322 of file CorrectObservables.hpp.

satTypeValueMap & Process (  const DayTime &  time,
satTypeValueMap &  gData
)  throw (ProcessingException) [virtual]
 

Returns a satTypeValueMap object, adding the new data generated when calling this object.

Parameters:
time Epoch corresponding to the data.
gData Data object holding the data.

Definition at line 59 of file CorrectObservables.cpp.

References Triple::dot(), GPSTK_THROW, Triple::R2(), Triple::R3(), gpstk::SatIDSet, Triple::theArray, and Triple::unitVector().

virtual CorrectObservables& setAntenna (  const Antenna &  antennaObj  )  [inline, virtual]
 

Sets the antenna object to be used.

Parameters:
antennaObj Antenna object to be used.

Definition at line 501 of file CorrectObservables.hpp.

virtual CorrectObservables& setEphemeris (  XvtStore< SatID > &  ephem  )  [inline, virtual]
 

Sets satellite ephemeris object to be used.

Parameters:
ephem Satellite ephemeris object.

Definition at line 361 of file CorrectObservables.hpp.

virtual CorrectObservables& setExtraBiases (  const Triple &  extra  )  [inline, virtual]
 

Sets extra biases affecting monument, such as tidal effects ([UEN]).

Parameters:
extra Extra biases affecting monument, such as tidal effects ([UEN]).

Definition at line 488 of file CorrectObservables.hpp.

virtual CorrectObservables& setL1pc (  const Triple &  L1pc  )  [inline, virtual]
 

Sets position of antenna L1 phase center with respect to ARP ([UEN]).

Parameters:
L1pc L1 phase center with respect to ARP ([UEN]).

Definition at line 377 of file CorrectObservables.hpp.

virtual CorrectObservables& setL2pc (  const Triple &  L2pc  )  [inline, virtual]
 

Sets position of antenna L2 phase center with respect to ARP ([UEN]).

Parameters:
L2pc L2 phase center with respect to ARP ([UEN]).

Definition at line 393 of file CorrectObservables.hpp.

virtual CorrectObservables& setL5pc (  const Triple &  L5pc  )  [inline, virtual]
 

Sets position of antenna L5 phase center with respect to ARP ([UEN]).

Parameters:
L5pc L5 phase center with respect to ARP ([UEN]).

Definition at line 409 of file CorrectObservables.hpp.

virtual CorrectObservables& setL6pc (  const Triple &  L6pc  )  [inline, virtual]
 

Sets position of antenna L6 phase center with respect to ARP ([UEN]).

Parameters:
L6pc L6 phase center with respect to ARP ([UEN]).

Definition at line 425 of file CorrectObservables.hpp.

virtual CorrectObservables& setL7pc (  const Triple &  L7pc  )  [inline, virtual]
 

Sets position of antenna L7 phase center with respect to ARP ([UEN]).

Parameters:
L7pc L7 phase center with respect to ARP ([UEN]).

Definition at line 441 of file CorrectObservables.hpp.

virtual CorrectObservables& setL8pc (  const Triple &  L8pc  )  [inline, virtual]
 

Sets position of antenna L8 phase center with respect to ARP ([UEN]).

Parameters:
L8pc L8 phase center with respect to ARP ([UEN]).

Definition at line 457 of file CorrectObservables.hpp.

virtual CorrectObservables& setMonument (  const Triple &  monument  )  [inline, virtual]
 

Sets vector from monument to ARP ([UEN]).

Parameters:
monument Vector from monument to ARP ([UEN]).

Definition at line 471 of file CorrectObservables.hpp.

virtual CorrectObservables& setNominalPosition (  const Position &  stapos  )  [inline, virtual]
 

Sets nominal position of receiver station.

Parameters:
stapos Nominal position of receiver station.

Definition at line 346 of file CorrectObservables.hpp.

virtual CorrectObservables& setUseAzimuth (  bool  useAzimuthPattern  )  [inline, virtual]
 

Sets whether azimuth-dependent antenna patterns will be used.

Parameters:
useAzimuthPattern Whether azimuth patterns will be used.

Definition at line 515 of file CorrectObservables.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 03:31:28 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1