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

ObsClockModel Class Reference

#include <ObsClockModel.hpp>

Inheritance diagram for ObsClockModel:

Inheritance graph
[legend]
Collaboration diagram for ObsClockModel:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::map< SatID, SvMode > SvModeMap
 defines a store for each SV's SvMode
typedef std::map< SatID, SvStatus > SvStatusMap
 defines a store for each SV's SvStatus
enum  SvMode { IGNORE, HEALTHY, ALWAYS }
enum  SvStatus {
  USED, MANUAL, SVHEALTH, ELEVATION,
  WONKY, SIGMA
}

Public Member Functions

 ObsClockModel (double sigma=2, double elmask=0, SvMode mode=ALWAYS)
virtual void addEpoch (const ORDEpoch &re)=0 throw (gpstk::InvalidValue)
ObsClockModel & setSvModeMap (const SvModeMap &right) throw ()
 set a SvMode for all SVs.
ObsClockModel & setSvMode (const SatID &svid, const SvMode &mode) throw ()
 set the SvMode for a particular SV.
ObsClockModel & setSvMode (const SvMode &mode) throw ()
 set the SvMode for all SVs
ObsClockModel & setSigmaMultiplier (double right) throw ()
 set the sigma multiple for ORD stripping.
ObsClockModel & setElevationMask (double right) throw ()
 set the elevation mask angle for ORD stripping.
ObsClockModel & setUseWonkyData (bool right) throw ()
 Set useWonkyData true and ords that are flagged as wonky will be included in any clock estimation calculations.
const SvStatusMap & getSvStatusMap () const throw ()
 get the map indicating how each ORD was used in the bias computation.
SvStatus getSvStatus (const SatID &svid) const throw (ObjectNotFound)
 get the status of a particular ORD in the bias computation.
const SvModeMap & getSvModeMap () const throw ()
 get the map indicating how to use each ORD in the bias computation.
SvMode getSvMode (const SatID &svid) const throw (ObjectNotFound)
 get how a particular ORD is to be used in the bias computation.
double getSigmaMultiplier () const throw ()
 returns the sigma multiple value used for ORD stripping.
double getElevationMask () const throw ()
 returns the elevation mask angle used for ORD stripping.
bool getUseWonkyData () const throw ()
 return the current value of the userWonkyData flag.
Stats< double > simpleOrdClock (const ORDEpoch &oe) throw (InvalidValue)
 Computes an average of all ORD in the epoch that pass the elevation mask, and SvModeMap tests, removes those ORDS that exceede the sigmam value and returns the resulting statistics.
virtual void dump (std::ostream &s, short detail=1) const throw ()

Protected Attributes

double sigmam
 sigma multiple value for ORD stripping
double elvmask
 elevation mask angle for ORD stripping
SvStatusMap status
 map of ORD usage in bias computation
SvModeMap modes
 map of modes to use ORDs in bias computation
bool useWonkyData
 set to use ords that are flagged wonky

Friends

std::ostream & operator<< (std::ostream &s, const ObsClockModel &r)

Member Typedef Documentation

typedef std::map<SatID, SvMode> SvModeMap
 

defines a store for each SV's SvMode

Definition at line 84 of file ObsClockModel.hpp.

typedef std::map<SatID, SvStatus> SvStatusMap
 

defines a store for each SV's SvStatus

Definition at line 87 of file ObsClockModel.hpp.

Member Enumeration Documentation

enum SvMode
 

Enumeration values:
IGNORE  do not include ORDs from this SV
HEALTHY  include ORDs from this SV if it is healthy
ALWAYS  always include ORDs from this SV

Definition at line 66 of file ObsClockModel.hpp.

enum SvStatus
 

Enumeration values:
USED  ORD used in the clock bias computation.
MANUAL  ORD removed from computation by user request.
SVHEALTH  ORD removed from computation because SV unhealthy.
ELEVATION  ORD removed from computation because SV elevation < mask.
WONKY  ORD removed due to being flagged wonky.
SIGMA  ORD removed from computation because it was outlier.

Definition at line 73 of file ObsClockModel.hpp.

Constructor & Destructor Documentation

ObsClockModel (  double  sigma = 2,
double  elmask = 0,
SvMode  mode = ALWAYS
)  [inline]
 

Definition at line 89 of file ObsClockModel.hpp.

Member Function Documentation

virtual void addEpoch (  const ORDEpoch &  re  )  throw (gpstk::InvalidValue) [pure virtual]
 

Implemented in EpochClockModel, and LinearClockModel.

void dump (  std::ostream &  s,
short  detail = 1
)  const throw () [virtual]
 

Reimplemented in LinearClockModel.

Definition at line 172 of file ObsClockModel.cpp.

double getElevationMask (   )  const throw () [inline]
 

returns the elevation mask angle used for ORD stripping.

Returns:
elevation mask angle

Definition at line 194 of file ObsClockModel.hpp.

double getSigmaMultiplier (   )  const throw () [inline]
 

returns the sigma multiple value used for ORD stripping.

Returns:
sigma multiple

Definition at line 188 of file ObsClockModel.hpp.

ObsClockModel::SvMode getSvMode (  const SatID &  svid  )  const throw (ObjectNotFound)
 

get how a particular ORD is to be used in the bias computation.

Parameters:
prn the Sv number indicating the mode of interest
Returns:
SvMode
Exceptions:
ObjectNotFound a mode for that SV is not in the map

Definition at line 87 of file ObsClockModel.cpp.

References GPSTK_THROW.

const SvModeMap& getSvModeMap (   )  const throw () [inline]
 

get the map indicating how to use each ORD in the bias computation.

Returns:
a const reference to the SvModeMap

Definition at line 174 of file ObsClockModel.hpp.

ObsClockModel::SvStatus getSvStatus (  const SatID &  svid  )  const throw (ObjectNotFound)
 

get the status of a particular ORD in the bias computation.

Parameters:
prn the PRN number indicating the ORD of interest
Returns:
SvStatus
Exceptions:
ObjectNotFound an ORD for that SV is not in the map

Definition at line 58 of file ObsClockModel.cpp.

References GPSTK_THROW.

const SvStatusMap& getSvStatusMap (   )  const throw () [inline]
 

get the map indicating how each ORD was used in the bias computation.

Returns:
a const reference to the SvStatusMap

Definition at line 159 of file ObsClockModel.hpp.

bool getUseWonkyData (   )  const throw () [inline]
 

return the current value of the userWonkyData flag.

Definition at line 200 of file ObsClockModel.hpp.

ObsClockModel& setElevationMask (  double  right  )  throw () [inline]
 

set the elevation mask angle for ORD stripping.

Parameters:
right elevation mask angle value
Returns:
a reference to this object

Definition at line 144 of file ObsClockModel.hpp.

ObsClockModel& setSigmaMultiplier (  double  right  )  throw () [inline]
 

set the sigma multiple for ORD stripping.

Parameters:
right sigma multiple value
Returns:
a reference to this object

Definition at line 136 of file ObsClockModel.hpp.

ObsClockModel& setSvMode (  const SvMode &  mode  )  throw () [inline]
 

set the SvMode for all SVs

Parameters:
mode SvMode for the SVs
Returns:
a reference to this object

Definition at line 121 of file ObsClockModel.hpp.

ObsClockModel& setSvMode (  const SatID &  svid,
const SvMode &  mode
)  throw () [inline]
 

set the SvMode for a particular SV.

Parameters:
prn Sv number of the SV
mode SvMode for the SV
Returns:
a reference to this object

Definition at line 113 of file ObsClockModel.hpp.

ObsClockModel & setSvModeMap (  const SvModeMap &  right  )  throw ()
 

set a SvMode for all SVs.

Parameters:
right SvModeMap
Returns:
a reference to this object

Definition at line 74 of file ObsClockModel.cpp.

ObsClockModel& setUseWonkyData (  bool  right  )  throw () [inline]
 

Set useWonkyData true and ords that are flagged as wonky will be included in any clock estimation calculations.

Definition at line 150 of file ObsClockModel.hpp.

gpstk::Stats< double > simpleOrdClock (  const ORDEpoch &  oe  )  throw (InvalidValue)
 

Computes an average of all ORD in the epoch that pass the elevation mask, and SvModeMap tests, removes those ORDS that exceede the sigmam value and returns the resulting statistics.

This is effectivly a simple single epoch clock model.

Definition at line 103 of file ObsClockModel.cpp.

References Stats::Add(), Stats::Average(), ObsRngDev::getElevation(), ObsRngDev::getHealth(), ObsRngDev::getORD(), ValidType::is_valid(), Stats::N(), Stats::Reset(), Stats::StdDev(), and ObsRngDev::wonky.

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  s,
const ObsClockModel &  r
)  [friend]
 

Definition at line 212 of file ObsClockModel.hpp.

Member Data Documentation

double elvmask [protected]
 

elevation mask angle for ORD stripping

Definition at line 218 of file ObsClockModel.hpp.

SvModeMap modes [protected]
 

map of modes to use ORDs in bias computation

Definition at line 220 of file ObsClockModel.hpp.

double sigmam [protected]
 

sigma multiple value for ORD stripping

Definition at line 217 of file ObsClockModel.hpp.

SvStatusMap status [protected]
 

map of ORD usage in bias computation

Definition at line 219 of file ObsClockModel.hpp.

bool useWonkyData [protected]
 

set to use ords that are flagged wonky

Definition at line 221 of file ObsClockModel.hpp.

The documentation for this class was generated from the following files:
Generated on Sat May 25 03:31:50 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1