EclipsedSatFilter Class Reference
[GPS solution algorithms and Tropospheric]

#include <EclipsedSatFilter.hpp>

Inheritance diagram for EclipsedSatFilter:

[legend]Collaboration diagram for EclipsedSatFilter:

[legend]List of all members.

---

Detailed Description

This class filters out satellites that are eclipsed by Earth shadow.

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:

      // Input observation file stream
   RinexObsStream rin("ebre0300.02o");

      // Load the precise ephemeris file
   SP3EphemerisStore sp3Eph;
   sp3Eph.loadFile("igs11513.sp3");

      // Reference position of receiver station
   Position nominalPos(4833520.2269, 41537.00768, 4147461.489);

      // Object to compute basic model data
   BasicModel basicM(nominalPos, sp3Eph);

      // Object to detect and delete satellites in eclipse
   EclipsedSatFilter eclipsedSV;

      // Some more code and definitions here...

   gnssRinex gRin;  // GNSS data structure for fixed station data

   while(rin >> gRin)
   {

         // Apply the model on the GDS and delete satellites in eclipse
      gRin >> basicM >> eclipsedSV;
   }

The "EclipsedSatFilter" object will visit every satellite in the GNSS data structure that is "gRin" and will determine if such satellite is in eclipse, or whether it recently was.

This effect may be important when using precise positioning, because satellite orbits tend to degrade when satellites are in eclipse, or when they have been in eclipse recently.

There are two adjustable parameters in this class: Shadow cone angle (30 degrees by default), and the period after eclipse that the satellite will still be deemed unreliable (1800 seconds by default).

Definition at line 101 of file EclipsedSatFilter.hpp.

Public Member Functions
	EclipsedSatFilter ()
	Default constructor.
	EclipsedSatFilter (const double angle, const double pShTime)
	Common constructor.
virtual satTypeValueMap &	Process (const DayTime &epoch, 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 double	getConeAngle (void) const
	Returns aperture of shadow cone, in degrees.
virtual EclipsedSatFilter &	setConeAngle (const double angle)
	Sets aperture of shadow cone, in degrees.
virtual double	getPostShadowPeriod (void) const
	Returns time after exiting shadow that satellite will still be filtered out, in seconds.
virtual EclipsedSatFilter &	setPostShadowPeriod (const double pShTime)
	Sets time after exiting shadow that satellite will still be filtered out, in seconds.
virtual int	getIndex (void) const
	Returns an index identifying this object.
virtual std::string	getClassName (void) const
	Returns a string identifying this object.
virtual	~EclipsedSatFilter ()
	Destructor.

---

Constructor & Destructor Documentation

EclipsedSatFilter (   )  [inline]

Default constructor. Definition at line 106 of file EclipsedSatFilter.hpp.

EclipsedSatFilter (  const double  angle, const double  pShTime )  [inline]

Common constructor. Parameters: angle  Aperture angle of shadow cone, in degrees. pShTime  Time after exiting shadow that satellite will still be filtered out, in seconds. Definition at line 116 of file EclipsedSatFilter.hpp.

virtual ~EclipsedSatFilter (   )  [inline, virtual]

Destructor. Definition at line 189 of file EclipsedSatFilter.hpp.

---

Member Function Documentation

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

Returns a string identifying this object. Implements ProcessingClass. Definition at line 47 of file EclipsedSatFilter.cpp.

virtual double getConeAngle (  void   )  const [inline, virtual]

Returns aperture of shadow cone, in degrees. Definition at line 153 of file EclipsedSatFilter.hpp.

int getIndex (  void   )  const [virtual]

Returns an index identifying this object. Implements ProcessingClass. Definition at line 42 of file EclipsedSatFilter.cpp.

virtual double getPostShadowPeriod (  void   )  const [inline, virtual]

Returns time after exiting shadow that satellite will still be filtered out, in seconds. Definition at line 168 of file EclipsedSatFilter.hpp.

gnssRinex & Process (  gnssRinex &  gData  )  throw (ProcessingException) [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 212 of file EclipsedSatFilter.cpp. References GPSTK_THROW.

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 138 of file EclipsedSatFilter.hpp.

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

Returns a satTypeValueMap object, adding the new data generated when calling this object. Parameters: epoch  Time of observations. gData  Data object holding the data. Definition at line 99 of file EclipsedSatFilter.cpp. References gpstk::abs(), SunPosition::getPosition(), GPSTK_THROW, PI, gpstk::SatIDSet, and Triple::unitVector().

EclipsedSatFilter & setConeAngle (  const double  angle  )  [virtual]

Sets aperture of shadow cone, in degrees. Parameters: angle  Aperture angle of shadow cone, in degrees. Warning: Valid values are within 0 and 90 degrees. Definition at line 58 of file EclipsedSatFilter.cpp.

EclipsedSatFilter & setPostShadowPeriod (  const double  pShTime  )  [virtual]

Sets time after exiting shadow that satellite will still be filtered out, in seconds. Parameters: pShTime  Time after exiting shadow that satellite will still be filtered out, in seconds. Definition at line 78 of file EclipsedSatFilter.cpp.

---

The documentation for this class was generated from the following files:

• EclipsedSatFilter.hpp
• EclipsedSatFilter.cpp

---