Detailed Description

Definition at line 66 of file ObsClockModel.hpp.

#include <ObsClockModel.hpp>

Inheritance diagram for gnsstk::ObsClockModel:

[legend]

Public Types
enum	SvMode { IGNORE, HEALTHY, ALWAYS }

typedef std::map< SatID, SvMode >	SvModeMap
	defines a store for each SV's SvMode More...

enum	SvStatus { USED, MANUAL, SVHEALTH, ELEVATION, WONKY, SIGMA }

typedef std::map< SatID, SvStatus >	SvStatusMap
	defines a store for each SV's SvStatus More...

Public Member Functions
virtual void	addEpoch (const ORDEpoch &re)=0

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

double	getElevationMask () const noexcept

double	getSigmaMultiplier () const noexcept

SvMode	getSvMode (const SatID &svid) const

const SvModeMap &	getSvModeMap () const noexcept

SvStatus	getSvStatus (const SatID &svid) const

const SvStatusMap &	getSvStatusMap () const noexcept

bool	getUseWonkyData () const noexcept

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

ObsClockModel &	setElevationMask (double right) noexcept

ObsClockModel &	setSigmaMultiplier (double right) noexcept

ObsClockModel &	setSvMode (const SatID &svid, const SvMode &mode) noexcept

ObsClockModel &	setSvMode (const SvMode &mode) noexcept

ObsClockModel &	setSvModeMap (const SvModeMap &right) noexcept

ObsClockModel &	setUseWonkyData (bool right) noexcept

Stats< double >	simpleOrdClock (const ORDEpoch &oe)

Public Member Functions inherited from gnsstk::ClockModel
	ClockModel () noexcept

virtual double	getOffset (const gnsstk::CommonTime &t) const =0

virtual bool	isOffsetValid (const gnsstk::CommonTime &t) const =0

Protected Attributes
double	elvmask
	elevation mask angle for ORD stripping More...

SvModeMap	modes
	map of modes to use ORDs in bias computation More...

double	sigmam
	sigma multiple value for ORD stripping More...

SvStatusMap	status
	map of ORD usage in bias computation More...

bool	useWonkyData
	set to use ords that are flagged wonky More...

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

Member Typedef Documentation

◆ SvModeMap

typedef std::map<SatID, SvMode> gnsstk::ObsClockModel::SvModeMap

defines a store for each SV's SvMode

Definition at line 87 of file ObsClockModel.hpp.

◆ SvStatusMap

typedef std::map<SatID, SvStatus> gnsstk::ObsClockModel::SvStatusMap

defines a store for each SV's SvStatus

Definition at line 90 of file ObsClockModel.hpp.

Member Enumeration Documentation

◆ SvMode

enum gnsstk::ObsClockModel::SvMode

Enumerator
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 69 of file ObsClockModel.hpp.

◆ SvStatus

enum gnsstk::ObsClockModel::SvStatus

Enumerator
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 76 of file ObsClockModel.hpp.

Constructor & Destructor Documentation

◆ ObsClockModel()

gnsstk::ObsClockModel::ObsClockModel	(	double	sigma = `2`,
		double	elmask = `0`,
		SvMode	mode = `ALWAYS`
	)

inline

Definition at line 92 of file ObsClockModel.hpp.

Member Function Documentation

◆ addEpoch()

virtual void gnsstk::ObsClockModel::addEpoch ( const ORDEpoch & re )

pure virtual

Exceptions

InvalidValue

Implemented in gnsstk::ObsClockModel_Child, gnsstk::EpochClockModel, and gnsstk::LinearClockModel.

◆ dump()

void gnsstk::ObsClockModel::dump	(	std::ostream &	s,
		short	detail = `1`
	)		const

virtualnoexcept

Reimplemented in gnsstk::LinearClockModel.

Definition at line 172 of file ObsClockModel.cpp.

◆ getElevationMask()

double gnsstk::ObsClockModel::getElevationMask ( ) const

inlinenoexcept

returns the elevation mask angle used for ORD stripping.

Returns: elevation mask angle

Definition at line 201 of file ObsClockModel.hpp.

◆ getSigmaMultiplier()

double gnsstk::ObsClockModel::getSigmaMultiplier ( ) const

inlinenoexcept

returns the sigma multiple value used for ORD stripping.

Returns: sigma multiple

Definition at line 195 of file ObsClockModel.hpp.

◆ getSvMode()

ObsClockModel::SvMode gnsstk::ObsClockModel::getSvMode ( const SatID & svid ) const

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

Parameters

svid	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 86 of file ObsClockModel.cpp.

◆ getSvModeMap()

const SvModeMap& gnsstk::ObsClockModel::getSvModeMap ( ) const

inlinenoexcept

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

Returns: a const reference to the SvModeMap

Definition at line 181 of file ObsClockModel.hpp.

◆ getSvStatus()

ObsClockModel::SvStatus gnsstk::ObsClockModel::getSvStatus ( const SatID & svid ) const

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

Parameters

svid	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.

◆ getSvStatusMap()

const SvStatusMap& gnsstk::ObsClockModel::getSvStatusMap ( ) const

inlinenoexcept

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

Returns: a const reference to the SvStatusMap

Definition at line 166 of file ObsClockModel.hpp.

◆ getUseWonkyData()

bool gnsstk::ObsClockModel::getUseWonkyData ( ) const

inlinenoexcept

return the current value of the userWonkyData flag.

Definition at line 207 of file ObsClockModel.hpp.

◆ setElevationMask()

ObsClockModel& gnsstk::ObsClockModel::setElevationMask ( double right )

inlinenoexcept

set the elevation mask angle for ORD stripping.

Parameters

right elevation mask angle value

Returns: a reference to this object

Definition at line 150 of file ObsClockModel.hpp.

◆ setSigmaMultiplier()

ObsClockModel& gnsstk::ObsClockModel::setSigmaMultiplier ( double right )

inlinenoexcept

set the sigma multiple for ORD stripping.

Parameters

right sigma multiple value

Returns: a reference to this object

Definition at line 142 of file ObsClockModel.hpp.

◆ setSvMode() [1/2]

ObsClockModel& gnsstk::ObsClockModel::setSvMode	(	const SatID &	svid,
		const SvMode &	mode
	)

inlinenoexcept

set the SvMode for a particular SV.

Parameters

svid	Sv number of the SV
mode	SvMode for the SV

Returns: a reference to this object

Definition at line 119 of file ObsClockModel.hpp.

◆ setSvMode() [2/2]

ObsClockModel& gnsstk::ObsClockModel::setSvMode ( const SvMode & mode )

inlinenoexcept

set the SvMode for all SVs

Parameters

mode	SvMode for the SVs

Returns: a reference to this object

Definition at line 127 of file ObsClockModel.hpp.

◆ setSvModeMap()

ObsClockModel & gnsstk::ObsClockModel::setSvModeMap ( const SvModeMap & right )

noexcept

set a SvMode for all SVs.

Parameters

right SvModeMap

Returns: a reference to this object

Definition at line 73 of file ObsClockModel.cpp.

◆ setUseWonkyData()

ObsClockModel& gnsstk::ObsClockModel::setUseWonkyData ( bool right )

inlinenoexcept

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

Definition at line 156 of file ObsClockModel.hpp.

◆ simpleOrdClock()

gnsstk::Stats< double > gnsstk::ObsClockModel::simpleOrdClock ( const ORDEpoch & oe )

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.

Exceptions

InvalidValue
InvalidValue

Definition at line 104 of file ObsClockModel.cpp.

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 220 of file ObsClockModel.hpp.

Member Data Documentation

◆ elvmask

double gnsstk::ObsClockModel::elvmask

protected

elevation mask angle for ORD stripping

Definition at line 226 of file ObsClockModel.hpp.

◆ modes

SvModeMap gnsstk::ObsClockModel::modes

protected

map of modes to use ORDs in bias computation

Definition at line 228 of file ObsClockModel.hpp.

◆ sigmam

double gnsstk::ObsClockModel::sigmam

protected

sigma multiple value for ORD stripping

Definition at line 221 of file ObsClockModel.hpp.

◆ status

SvStatusMap gnsstk::ObsClockModel::status

protected

map of ORD usage in bias computation

Definition at line 227 of file ObsClockModel.hpp.

◆ useWonkyData

bool gnsstk::ObsClockModel::useWonkyData

protected

set to use ords that are flagged wonky

Definition at line 229 of file ObsClockModel.hpp.

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

Detailed Description

Public Types

Public Member Functions

Protected Attributes

Friends

Member Typedef Documentation

◆ SvModeMap

◆ SvStatusMap

Member Enumeration Documentation

◆ SvMode

◆ SvStatus

Constructor & Destructor Documentation

◆ ObsClockModel()

Member Function Documentation

◆ addEpoch()

◆ dump()

◆ getElevationMask()

◆ getSigmaMultiplier()

◆ getSvMode()

◆ getSvModeMap()

◆ getSvStatus()

◆ getSvStatusMap()

◆ getUseWonkyData()

◆ setElevationMask()

◆ setSigmaMultiplier()

◆ setSvMode() [1/2]

◆ setSvMode() [2/2]

◆ setSvModeMap()

◆ setUseWonkyData()

◆ simpleOrdClock()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ elvmask

◆ modes

◆ sigmam

◆ status

◆ useWonkyData