SatPass Class Reference

#include <SatPass.hpp>

Inheritance diagram for SatPass:

[legend]Collaboration diagram for SatPass:

Detailed Description

class SatPass holds all range and phase data for a full satellite pass.

Constructed and filled by the calling program, it is used to pass data into and out of the GPSTK discontinuity corrector. NB. if objects of this class are combined together, e.g. in STL containers such as list or vector, they MUST be consistently defined, namely the number of observation types must be the same, otherwise a nasty segmentation fault can occur when building the STL container.

Definition at line 52 of file SatPass.hpp.

Public Member Functions

SatPass (GSatID sat, double dt) throw ()

Constructor for the given sat; default obs types are L1, L2, P1, P2, in that order; dt is the nominal time spacing of the data.

SatPass (GSatID sat, double dt, std::vector< std::string > obstypes) throw ()

Constructor from a list of strings <=> RINEX obs types to be read NB.

SatPass & operator= (const SatPass &right) throw ()

int addData (const CommonTime tt, std::vector< std::string > &obstypes, std::vector< double > &data) throw (Exception)

Add vector of data, identified by obstypes (same as used in c'tor) at tt, Flag is set 'good' and lli=ssi=0.

int addData (const CommonTime tt, std::vector< std::string > &obstypes, std::vector< double > &data, std::vector< unsigned short > &lli, std::vector< unsigned short > &ssi, unsigned short flag=SatPass::OK) throw (Exception)

Add vector of data, identified by obstypes (same as used in c'tor) at tt, Flag, lli and ssi are set using input (parallel to data).

int addData (const RinexObsData &robs) throw ()

Add data as found in RinexObsData.

void smooth (bool smoothPR, bool smoothPH, std::string &msg) throw (Exception)

Smooth pseudorange and debias phase.

int & status (void) throw ()

Access the status; l-value may be assigned SP.status() = 1;.

double & data (unsigned int i, std::string type) throw (Exception)

Access the data for one obs type at one index, as either l-value or r-value.

double & timeoffset (unsigned int i) throw (Exception)

Access the time offset from the nominal time (i.e.

unsigned short & LLI (unsigned int i, std::string type) throw (Exception)

Access the LLI for one obs type at one index, as either l-value or r-value.

unsigned short & SSI (unsigned int i, std::string type) throw (Exception)

Access the ssi for one obs type at one index, as either l-value or r-value.

void setOutputFormat (std::string fmt)

set timetag output format

void setFlag (unsigned int i, unsigned short flag) throw (Exception)

set the flag at one index to flag - use the SatPass constants OK, etc.

double getMaxGap (void) const throw ()

get the max.

std::vector< std::string > getObsTypes (void) throw ()

get the list of obstypes

unsigned short getFlag (unsigned int i) throw (Exception)

get the flag at one index

CommonTime getFirstTime (void) const throw ()

the earliest time in this SatPass data

CommonTime getLastTime (void) const throw ()

the latest time in this SatPass data

CommonTime getFirstGoodTime (void) const throw ()

the earliest time of good data in this SatPass data

CommonTime getLastGoodTime (void) const throw ()

the latest time of good data in this SatPass data

GSatID getSat (void) const throw ()

get the satellite of this SatPass

double getDT (void) const throw ()

get the time interval of this SatPass

int getNgood (void) const throw ()

get the number of good points in this SatPass

unsigned int size (void) const throw ()

get the size of (the arrays in) this SatPass

unsigned int getCount (unsigned int i) const throw (Exception)

get one element of the count array of this SatPass

void clear (void) throw ()

clear the data (but not the obs types) from the arrays

CommonTime time (unsigned int i) const throw (Exception)

compute the timetag associated with index i in the data array

bool includesTime (const CommonTime &tt) const throw ()

return true if the given timetag is or could be part of this pass

bool split (int N, SatPass &newSP)

create a new SatPass from the given one, starting at count N.

void decimate (const int N, CommonTime refTime=CommonTime::BEGINNING_OF_TIME) throw (Exception)

Decimate the data in the SatPass by (integer) factor N, referencing refTime; that is keep only epochs that satisfy time=refTime+n*N*dt where n is also an integer, and dt is the current time spacing of the time spacing of the SatPass.

void dump (std::ostream &os, std::string msg1, std::string msg2=std::string()) throw ()

Dump all the data in the pass, one line per timetag.

bool operator< (const SatPass &right) const

'less than' is required for sort() and map<SatPass,...>.find(SatPass)

Static Public Member Functions

double setMaxGap (const double gap)

change the maximum time gap (in seconds) allowed within any SatPass

Static Public Attributes

const unsigned short BAD = 0

flag indicating bad data

const unsigned short OK = 1

flag indicating good data with no phase discontinuity NB test for 'good' data using (flag != SatPass::BAD), NOT (flag == SatPass::OK).

const unsigned short LL1 = 2

flag indicating good data with phase discontinuity on L1 only.

const unsigned short LL2 = 4

flag indicating good data with phase discontinuity on L2 only.

const unsigned short LL3 = 6

flag indicating good data with phase discontinuity on both L1 and L2.

double maxGap = 1800

size of maximum time gap, in seconds, allowed within SatPass data.

std::string outFormat = string("%4F %10.3g")

format string, as defined in class CommonTime, for output of times used by smooth (debug), dump and operator<<

Protected Member Functions

int countForTime (const CommonTime &tt) const throw (Exception)

compute the count associated with the time tt; return -1 if not within the time limits of the SatPass

void init (GSatID sat, double dt, std::vector< std::string > obstypes) throw ()

called by constructors to initialize - see doc for them.

int push_back (const CommonTime tt, SatPassData &spd) throw ()

add a complete SatPassData at time tt

SatPassData getData (unsigned int i) const throw (Exception)

get a complete SatPassData at count i

Protected Attributes

int Status

Status flag for use exclusively by the caller.

double dt

Nominal time spacing of the data; determined on input or by decimate().

GSatID sat

Satellite identifier for this data.

std::map< std::string, unsigned
int > indexForLabel

STL map relating strings identifying obs types with indexes in SatPassData.

std::map< unsigned int, std::string > labelForIndex

CommonTime firstTime

timetags of the first and last data points.

CommonTime lastTime

timetags of the first and last data points.

unsigned int ngood

number of timetags with good data in the data arrays.

std::vector< SatPassData > spdvector

ALL data in the pass, stored in SatPassData objects, in time order.

Friends

class SatPassIterator

class SatPassIterator allows the caller to access all the data in a list of SatPass objects in time order.

std::ostream & operator<< (std::ostream &os, SatPass &sp)

Write a one-line summary of the object, consisting of total points, satellite, number of good points, status, start time, end time, time step (sec), and observation types.

void sort (std::vector< SatPass > &SPList) throw ()

Sort a vector<SatPass> on time, using the firstTime member.

int SatPassFromRinexFiles (std::vector< std::string > &filenames, std::vector< std::string > &obstypes, double dt, std::vector< SatPass > &SPList, gpstk::CommonTime beginTime=gpstk::CommonTime::BEGINNING_OF_TIME, gpstk::CommonTime endTime=gpstk::CommonTime::END_OF_TIME) throw (Exception)

Read a set of RINEX observation files, filling a vector of SatPass objects.

int SatPassToRinexFile (std::string filename, RinexObsHeader &header, std::vector< SatPass > &SPList) throw (Exception)

Iterate over the input vector of SatPass objects (sorted to be in time order) and write them, with the given header, to a RINEX observation file of the given filename.

Constructor & Destructor Documentation

SatPass ( GSatID sat,

double dt

) throw ()

Constructor for the given sat; default obs types are L1, L2, P1, P2, in that order; dt is the nominal time spacing of the data.
NB. dt MUST be correct.
Parameters:

sat the satellite from which this data comes

dt the nominal time spacing (seconds) of the data

Definition at line 65 of file SatPass.cpp.
Referenced by SatPass::split().

SatPass ( GSatID sat,

double dt,

std::vector< std::string > obstypes

) throw ()

Constructor from a list of strings <=> RINEX obs types to be read NB.
The number of obstypes determines the size of the SatPass object; therefore objects with different numbers of obs types must not be combined together in things like STL containers, which assume a fixed size for all objects of one class. NB. dt MUST be correct.
Parameters:

sat the satellite from which this data comes

dt the nominal time spacing (seconds) of the data

obstypes a vector of strings, each string being a 2-character RINEX observation type, e.g. "L1", "P2", to be stored.

Member Function Documentation

int addData ( const RinexObsData & robs ) throw ()

Add data as found in RinexObsData.
No action if this->sat is not found. Pull out time tag and all data in obs type list. All flags are set 'good'.
Parameters:

robs Rinex observation data from which to pull data. Only data for the object's satellite is added.

Returns:
n>=0 if data was added successfully, n is the index of the new data -1 if a gap is found (no data is added), -2 if time tag is out of order (no data is added) -3 if the satellite was not found in the RinexObsData (no data added)

Definition at line 167 of file SatPass.cpp.

int addData ( const CommonTime tt,

std::vector< std::string > & obstypes,

std::vector< double > & data,

std::vector< unsigned short > & lli,

std::vector< unsigned short > & ssi,

unsigned short flag = SatPass::OK

) throw (Exception)

Add vector of data, identified by obstypes (same as used in c'tor) at tt, Flag, lli and ssi are set using input (parallel to data).

Parameters:

tt the time tag of interest

obstypes a vector of strings, each string being a 2-character RINEX observation type, e.g. "L1", "P2", to be stored. This MUST match the list used in the constructor.

data a vector of data values, parallel to the obstypes vector

lli a vector of LLI values, parallel to the obstypes vector

ssi a vector of SSI values, parallel to the obstypes vector

Returns:
n>=0 if data was added successfully, n is the index of the new data -1 if a gap is found (no data is added), -2 if time tag is out of order (no data is added)

Definition at line 126 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.

int addData ( const CommonTime tt,

std::vector< std::string > & obstypes,

std::vector< double > & data

) throw (Exception)

Add vector of data, identified by obstypes (same as used in c'tor) at tt, Flag is set 'good' and lli=ssi=0.

Parameters:

tt the time tag of interest

obstypes a vector of strings, each string being a 2-character RINEX observation type, e.g. "L1", "P2", to be stored. This MUST match the list used in the constructor.

data a vector of data values, parallel to the obstypes vector

Returns:
n>=0 if data was added successfully, n is the index of the new data -1 if a gap is found (no data is added), -2 if time tag is out of order (no data is added)

Definition at line 115 of file SatPass.cpp.
References GPSTK_RETHROW.
Referenced by GDCPass::GDCPass().

void clear ( void ) throw () [inline]

clear the data (but not the obs types) from the arrays

Definition at line 269 of file SatPass.hpp.
Referenced by GDCPass::GDCPass().

int countForTime ( const CommonTime & tt ) const throw (Exception) [inline, protected]

compute the count associated with the time tt; return -1 if not within the time limits of the SatPass

Parameters:

tt the time tag of interest

Definition at line 351 of file SatPass.hpp.
Referenced by SatPass::split().

double & data ( unsigned int i,

std::string type

) throw (Exception)

Access the data for one obs type at one index, as either l-value or r-value.

Parameters:

i index of the data of interest

type observation type (e.g. "L1") of the data of interest

Returns:
the data of the given type at the given index

Definition at line 305 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.
Referenced by GDCPass::GDCPass(), and SatPass::SatPassData::operator=().

void decimate ( const int N,

CommonTime refTime = CommonTime::BEGINNING_OF_TIME

) throw (Exception)

Decimate the data in the SatPass by (integer) factor N, referencing refTime; that is keep only epochs that satisfy time=refTime+n*N*dt where n is also an integer, and dt is the current time spacing of the time spacing of the SatPass.
This routine decimates the data, reduces the arrays, and may change the start and stop times and ngood; time offsets are not changed.
Parameters:

N New time spacing is N(>1) times the current time spacing

refTime Reference CommonTime for the decimation, default is to use first in pass

Definition at line 458 of file SatPass.cpp.
References GPSTK_RETHROW.

void dump ( std::ostream & os,

std::string msg1,

std::string msg2 = std::string()

) throw ()

Dump all the data in the pass, one line per timetag.

Parameters:

os output stream

msg1 put message msg1 at beginning of each line,

msg2 put msg2 at the end of the first (#comment) line.

Definition at line 501 of file SatPass.cpp.
References gpstk::printTime().

unsigned int getCount ( unsigned int i ) const throw (Exception)

get one element of the count array of this SatPass

Parameters:

i index of the data of interest

Returns:
the count at the given index. Count is the number of timesteps DT between the first time tag and the current time tag.

Definition at line 381 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.

struct SatPass::SatPassData getData ( unsigned int i ) const throw (Exception) [protected]

get a complete SatPassData at count i

Definition at line 580 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.

double getDT ( void ) const throw () [inline]

get the time interval of this SatPass

Returns:
the nominal time step (seconds) in this data

Definition at line 250 of file SatPass.hpp.
Referenced by GDCPass::GDCPass().

CommonTime getFirstGoodTime ( void ) const throw () [inline]

the earliest time of good data in this SatPass data

Definition at line 229 of file SatPass.hpp.

CommonTime getFirstTime ( void ) const throw () [inline]

the earliest time in this SatPass data

Definition at line 215 of file SatPass.hpp.

unsigned short getFlag ( unsigned int i ) throw (Exception)

get the flag at one index

Parameters:

i index of the data of interest

Returns:
the flag for the given index

Definition at line 371 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.
Referenced by GDCPass::GDCPass().

CommonTime getLastGoodTime ( void ) const throw () [inline]

the latest time of good data in this SatPass data

Definition at line 237 of file SatPass.hpp.

CommonTime getLastTime ( void ) const throw () [inline]

the latest time in this SatPass data
This should be necessary only when the timeoffset's have been altered...use with caution.
Parameters:

tt new first time

Definition at line 226 of file SatPass.hpp.

double getMaxGap ( void ) const throw () [inline]

get the max.
gap limit size (seconds); for all SatPass objects
Returns:
the current value of maximum gap (sec)

Definition at line 199 of file SatPass.hpp.

int getNgood ( void ) const throw () [inline]

get the number of good points in this SatPass

Returns:
the number of good points (flag != BAD) in this object

Definition at line 254 of file SatPass.hpp.

std::vector<std::string> getObsTypes ( void ) throw () [inline]

get the list of obstypes

Returns:
the vector of strings giving RINEX obs types

Definition at line 203 of file SatPass.hpp.
Referenced by GDCPass::GDCPass().

GSatID getSat ( void ) const throw () [inline]

get the satellite of this SatPass

Returns:
the satellite of this SatPass data

Definition at line 246 of file SatPass.hpp.
Referenced by GDCPass::GDCPass().

bool includesTime ( const CommonTime & tt ) const throw ()

return true if the given timetag is or could be part of this pass

Parameters:

tt the time tag of interest

Returns:
true if the given time tag lies within the time interval covered by this object.

Definition at line 404 of file SatPass.cpp.

void init ( GSatID sat,

double dt,

std::vector< std::string > obstypes

) throw () [protected]

called by constructors to initialize - see doc for them.

unsigned short & LLI ( unsigned int i,

std::string type

) throw (Exception)

Access the LLI for one obs type at one index, as either l-value or r-value.

Parameters:

i index of the data of interest

type observation type (e.g. "L1") of the data of interest

Returns:
the LLI of the given type at the given index

Definition at line 328 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.
Referenced by GDCPass::GDCPass().

bool operator< ( const SatPass & right ) const [inline]

'less than' is required for sort() and map<SatPass,...>.find(SatPass)

Definition at line 306 of file SatPass.hpp.
References SatPass::firstTime.

SatPass & operator= ( const SatPass & right ) throw ()

Definition at line 96 of file SatPass.cpp.

int push_back ( const CommonTime tt,

SatPassData & spd

) throw () [protected]

add a complete SatPassData at time tt

Returns:
n>=0 if data was added successfully, n is the index of the new data -1 if a gap is found (no data is added), -2 if time tag is out of order (no data is added)

Definition at line 552 of file SatPass.cpp.
Referenced by GDCPass::GDCPass(), and SatPass::split().

void setFlag ( unsigned int i,

unsigned short flag

) throw (Exception)

set the flag at one index to flag - use the SatPass constants OK, etc.

Parameters:

i index of the data of interest

flag flag (e.g. SatPass::BAD).

Definition at line 357 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.

double setMaxGap ( const double gap ) [inline, static]

change the maximum time gap (in seconds) allowed within any SatPass

Parameters:

gap The maximum time gap (in seconds) allowed within any SatPass

Returns:
the input value.

Definition at line 183 of file SatPass.hpp.

void setOutputFormat ( std::string fmt ) [inline]

set timetag output format

Parameters:

fmt The format of time tags in the output (cf. gpstk CommonTime::printf() for syntax)

Definition at line 188 of file SatPass.hpp.

unsigned int size ( void ) const throw () [inline]

get the size of (the arrays in) this SatPass

Returns:
the size of the data array in this object

Definition at line 258 of file SatPass.hpp.
Referenced by GDCPass::detectWLsmallSlips(), GDCPass::GDCPass(), gpstk::operator<<(), SatPass::SatPassData::operator=(), GDCPass::preprocess(), and GDCPass::WLconsistencyCheck().

void smooth ( bool smoothPR,

bool smoothPH,

std::string & msg

) throw (Exception)

Smooth pseudorange and debias phase.
This routine can be called only if dual frequency range and phase data (P1,P2,L1,L2) have been stored, and should be called only after all cycleslips have been removed.
Parameters:

smoothPR if true, replace the pseudorange (P1 and P2) with smoothed ranges.

smoothPH if true, replace the phase (L1 and L2) with debiased phase.

msg a string containing a single-line statistical summary of the smoothing results, and the estimated phase biases. This string consists of the following 18 fields separated by whitespace. 1) "SMT", 2) satellite id (e.g. G07), 3) start GPS week, 4) start GPS seconds of week, 5) end GPS week, 6) end GPS seconds of week, (7-11 are for the L1 bias data in units of meters) 7) number, 8) average, 9) std deviation, 10) minimum, and 11) maximum, (12-16 are for the L2 bias data in units of meters) 12) number, 13) average, 14) std deviation, 15) minimum, and 16) maximum, 17) the L1 bias in cycles, 18) the L2 bias in cycles.

Definition at line 204 of file SatPass.cpp.
References Stats::Add(), Stats::Average(), F1, F2, GPSTK_THROW, Stats::Maximum(), Stats::Minimum(), Stats::N(), P1, P2, gpstk::printTime(), Stats::StdDev(), wl1, and wl2.

bool split ( int N,

SatPass & newSP

)

create a new SatPass from the given one, starting at count N.
modify this SatPass to end just before N. return true if successful.
Definition at line 418 of file SatPass.cpp.
References SatPass::countForTime(), SatPass::dt, SatPass::firstTime, GPSTK_RETHROW, SatPass::indexForLabel, SatPass::labelForIndex, SatPass::lastTime, SatPass::ngood, SatPass::push_back(), SatPass::sat, SatPass::SatPass(), SatPass::spdvector, SatPass::Status, and SatPass::time().

unsigned short & SSI ( unsigned int i,

std::string type

) throw (Exception)

Access the ssi for one obs type at one index, as either l-value or r-value.

Parameters:

i index of the data of interest

type observation type (e.g. "L1") of the data of interest

Returns:
the SSI of the given type at the given index

Definition at line 342 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.
Referenced by GDCPass::GDCPass().

int& status ( void ) throw () [inline]

Access the status; l-value may be assigned SP.status() = 1;.

Definition at line 152 of file SatPass.hpp.
Referenced by GDCPass::GDCPass().

CommonTime time ( unsigned int i ) const throw (Exception)

compute the timetag associated with index i in the data array

Parameters:

i index of the data of interest

Returns:
the time tag at the given index.

Definition at line 392 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.
Referenced by GDCPass::detectWLslips(), GDCPass::detectWLsmallSlips(), GDCPass::GDCPass(), GDCPass::preprocess(), SatPass::split(), and GDCPass::WLconsistencyCheck().

double & timeoffset ( unsigned int i ) throw (Exception)

Access the time offset from the nominal time (i.e.
timetag) at one index (epoch), as either l-value or r-value
Parameters:

i index of the data of interest

Returns:
the time offset from nominal at the given index

Definition at line 319 of file SatPass.cpp.
References gpstk::StringUtils::asString(), and GPSTK_THROW.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream & os,

SatPass & sp

) [friend]

Write a one-line summary of the object, consisting of total points, satellite, number of good points, status, start time, end time, time step (sec), and observation types.

Parameters:

os output stream

sp SatPass object to output

int SatPassFromRinexFiles ( std::vector< std::string > & filenames,

std::vector< std::string > & obstypes,

double dt,

std::vector< SatPass > & SPList,

gpstk::CommonTime beginTime = gpstk::CommonTime::BEGINNING_OF_TIME,

gpstk::CommonTime endTime = gpstk::CommonTime::END_OF_TIME

) throw (Exception) [friend]

Read a set of RINEX observation files, filling a vector of SatPass objects.
Create the SatPass objects using the input list of observation types and timestep. If there are no obs types given (vector obstypes has size 0), then use the obs types in the header of the first file read. The files are sorted on their begin time before processing, and the resulting list of SatPass objects is in time order. Data before the begin time, and after the end time, is ignored. The list of SatPass objects need not be empty on input; however if not empty, then the list must be consistent with the input timestep and obs type list, and it will be sorted to be in time order. If a file cannot be opened, or it is not RINEX observations, simply skip it.
Parameters:

filenames vector of input RINEX observation file names

obstypes vector of observation types to include in SatPass (may be empty: include all)

dt data interval of existing SPList and input files

SPList vector of SatPass objects to fill, need not be empty, but if not empty, must have consistent obs types and dt.

beginTime reject data before this time (BEGINNING_OF_TIME)

endTime reject data after this time (END_OF TIME)

Returns:
-1 if the filenames list is empty, otherwise return the number of files successfully read (may be less than the number input).

Exceptions:

gpstk Exceptions if there are exceptions while reading, or if the data in the file is out of time order

friend class SatPassIterator [friend]

class SatPassIterator allows the caller to access all the data in a list of SatPass objects in time order.

Definition at line 493 of file SatPass.hpp.

int SatPassToRinexFile ( std::string filename,

RinexObsHeader & header,

std::vector< SatPass > & SPList

) throw (Exception) [friend]

Iterate over the input vector of SatPass objects (sorted to be in time order) and write them, with the given header, to a RINEX observation file of the given filename.

Returns:
-1 if the file could not be opened, otherwise return 0.

void sort ( std::vector< SatPass > & SPList ) throw () [friend]

Sort a vector<SatPass> on time, using the firstTime member.

Referenced by SatPassIterator::SatPassIterator().

Member Data Documentation

const unsigned short BAD = 0 [static]

flag indicating bad data

Definition at line 57 of file SatPass.cpp.

double dt [protected]

Nominal time spacing of the data; determined on input or by decimate().

Definition at line 413 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

CommonTime firstTime [protected]

timetags of the first and last data points.

Definition at line 425 of file SatPass.hpp.
Referenced by SatPass::operator<(), gpstk::operator<<(), and SatPass::split().

std::map<std::string,unsigned int> indexForLabel [protected]

STL map relating strings identifying obs types with indexes in SatPassData.

Definition at line 419 of file SatPass.hpp.
Referenced by SatPass::split().

std::map<unsigned int,std::string> labelForIndex [protected]

Definition at line 420 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

CommonTime lastTime [protected]

timetags of the first and last data points.

Definition at line 425 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

const unsigned short LL1 = 2 [static]

flag indicating good data with phase discontinuity on L1 only.
if(flag & LL1) then there is an L1 discontinuity
Definition at line 58 of file SatPass.cpp.

const unsigned short LL2 = 4 [static]

flag indicating good data with phase discontinuity on L2 only.
if(flag & LL2) then there is an L2 discontinuity
Definition at line 59 of file SatPass.cpp.

const unsigned short LL3 = 6 [static]

flag indicating good data with phase discontinuity on both L1 and L2.
if(flag & LL3) then there are L1 and L2 discontinuities
Definition at line 60 of file SatPass.cpp.

double maxGap = 1800 [static]

size of maximum time gap, in seconds, allowed within SatPass data.

Definition at line 61 of file SatPass.cpp.

unsigned int ngood [protected]

number of timetags with good data in the data arrays.

Definition at line 428 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

const unsigned short OK = 1 [static]

flag indicating good data with no phase discontinuity NB test for 'good' data using (flag != SatPass::BAD), NOT (flag == SatPass::OK).

Definition at line 56 of file SatPass.cpp.

string outFormat = string("%4F %10.3g") [static]

format string, as defined in class CommonTime, for output of times used by smooth (debug), dump and operator<<

Definition at line 62 of file SatPass.cpp.

GSatID sat [protected]

Satellite identifier for this data.

Definition at line 416 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

std::vector<SatPassData> spdvector [protected]

ALL data in the pass, stored in SatPassData objects, in time order.

Definition at line 431 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

int Status [protected]

Status flag for use exclusively by the caller.
It is set to 0 by the constructors, but otherwise ignored by class SatPass and class SatPassIterator.
Definition at line 410 of file SatPass.hpp.
Referenced by gpstk::operator<<(), and SatPass::split().

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

Generated on Tue May 21 03:31:41 2013 for GPS ToolKit Software Library by

1.3.9.1


Public Member Functions
	SatPass (GSatID sat, double dt) throw ()
	Constructor for the given sat; default obs types are L1, L2, P1, P2, in that order; dt is the nominal time spacing of the data.
	SatPass (GSatID sat, double dt, std::vector< std::string > obstypes) throw ()
	Constructor from a list of strings <=> RINEX obs types to be read NB.
SatPass &	operator= (const SatPass &right) throw ()
int	addData (const CommonTime tt, std::vector< std::string > &obstypes, std::vector< double > &data) throw (Exception)
	Add vector of data, identified by obstypes (same as used in c'tor) at tt, Flag is set 'good' and lli=ssi=0.
int	addData (const CommonTime tt, std::vector< std::string > &obstypes, std::vector< double > &data, std::vector< unsigned short > &lli, std::vector< unsigned short > &ssi, unsigned short flag=SatPass::OK) throw (Exception)
	Add vector of data, identified by obstypes (same as used in c'tor) at tt, Flag, lli and ssi are set using input (parallel to data).
int	addData (const RinexObsData &robs) throw ()
	Add data as found in RinexObsData.
void	smooth (bool smoothPR, bool smoothPH, std::string &msg) throw (Exception)
	Smooth pseudorange and debias phase.
int &	status (void) throw ()
	Access the status; l-value may be assigned SP.status() = 1;.
double &	data (unsigned int i, std::string type) throw (Exception)
	Access the data for one obs type at one index, as either l-value or r-value.
double &	timeoffset (unsigned int i) throw (Exception)
	Access the time offset from the nominal time (i.e.
unsigned short &	LLI (unsigned int i, std::string type) throw (Exception)
	Access the LLI for one obs type at one index, as either l-value or r-value.
unsigned short &	SSI (unsigned int i, std::string type) throw (Exception)
	Access the ssi for one obs type at one index, as either l-value or r-value.
void	setOutputFormat (std::string fmt)
	set timetag output format
void	setFlag (unsigned int i, unsigned short flag) throw (Exception)
	set the flag at one index to flag - use the SatPass constants OK, etc.
double	getMaxGap (void) const throw ()
	get the max.
std::vector< std::string >	getObsTypes (void) throw ()
	get the list of obstypes
unsigned short	getFlag (unsigned int i) throw (Exception)
	get the flag at one index
CommonTime	getFirstTime (void) const throw ()
	the earliest time in this SatPass data
CommonTime	getLastTime (void) const throw ()
	the latest time in this SatPass data
CommonTime	getFirstGoodTime (void) const throw ()
	the earliest time of good data in this SatPass data
CommonTime	getLastGoodTime (void) const throw ()
	the latest time of good data in this SatPass data
GSatID	getSat (void) const throw ()
	get the satellite of this SatPass
double	getDT (void) const throw ()
	get the time interval of this SatPass
int	getNgood (void) const throw ()
	get the number of good points in this SatPass
unsigned int	size (void) const throw ()
	get the size of (the arrays in) this SatPass
unsigned int	getCount (unsigned int i) const throw (Exception)
	get one element of the count array of this SatPass
void	clear (void) throw ()
	clear the data (but not the obs types) from the arrays
CommonTime	time (unsigned int i) const throw (Exception)
	compute the timetag associated with index i in the data array
bool	includesTime (const CommonTime &tt) const throw ()
	return true if the given timetag is or could be part of this pass
bool	split (int N, SatPass &newSP)
	create a new SatPass from the given one, starting at count N.
void	decimate (const int N, CommonTime refTime=CommonTime::BEGINNING_OF_TIME) throw (Exception)
	Decimate the data in the SatPass by (integer) factor N, referencing refTime; that is keep only epochs that satisfy time=refTime+nNdt where n is also an integer, and dt is the current time spacing of the time spacing of the SatPass.
void	dump (std::ostream &os, std::string msg1, std::string msg2=std::string()) throw ()
	Dump all the data in the pass, one line per timetag.
bool	operator< (const SatPass &right) const
	'less than' is required for sort() and map<SatPass,...>.find(SatPass)
Static Public Member Functions
double	setMaxGap (const double gap)
	change the maximum time gap (in seconds) allowed within any SatPass
Static Public Attributes
const unsigned short	BAD = 0
	flag indicating bad data
const unsigned short	OK = 1
	flag indicating good data with no phase discontinuity NB test for 'good' data using (flag != SatPass::BAD), NOT (flag == SatPass::OK).
const unsigned short	LL1 = 2
	flag indicating good data with phase discontinuity on L1 only.
const unsigned short	LL2 = 4
	flag indicating good data with phase discontinuity on L2 only.
const unsigned short	LL3 = 6
	flag indicating good data with phase discontinuity on both L1 and L2.
double	maxGap = 1800
	size of maximum time gap, in seconds, allowed within SatPass data.
std::string	outFormat = string("%4F %10.3g")
	format string, as defined in class CommonTime, for output of times used by smooth (debug), dump and operator<<
Protected Member Functions
int	countForTime (const CommonTime &tt) const throw (Exception)
	compute the count associated with the time tt; return -1 if not within the time limits of the SatPass
void	init (GSatID sat, double dt, std::vector< std::string > obstypes) throw ()
	called by constructors to initialize - see doc for them.
int	push_back (const CommonTime tt, SatPassData &spd) throw ()
	add a complete SatPassData at time tt
SatPassData	getData (unsigned int i) const throw (Exception)
	get a complete SatPassData at count i
Protected Attributes
int	Status
	Status flag for use exclusively by the caller.
double	dt
	Nominal time spacing of the data; determined on input or by decimate().
GSatID	sat
	Satellite identifier for this data.
std::map< std::string, unsigned int >	indexForLabel
	STL map relating strings identifying obs types with indexes in SatPassData.
std::map< unsigned int, std::string >	labelForIndex
CommonTime	firstTime
	timetags of the first and last data points.
CommonTime	lastTime
	timetags of the first and last data points.
unsigned int	ngood
	number of timetags with good data in the data arrays.
std::vector< SatPassData >	spdvector
	ALL data in the pass, stored in SatPassData objects, in time order.
Friends
class	SatPassIterator
	class SatPassIterator allows the caller to access all the data in a list of SatPass objects in time order.
std::ostream &	operator<< (std::ostream &os, SatPass &sp)
	Write a one-line summary of the object, consisting of total points, satellite, number of good points, status, start time, end time, time step (sec), and observation types.
void	sort (std::vector< SatPass > &SPList) throw ()
	Sort a vector<SatPass> on time, using the firstTime member.
int	SatPassFromRinexFiles (std::vector< std::string > &filenames, std::vector< std::string > &obstypes, double dt, std::vector< SatPass > &SPList, gpstk::CommonTime beginTime=gpstk::CommonTime::BEGINNING_OF_TIME, gpstk::CommonTime endTime=gpstk::CommonTime::END_OF_TIME) throw (Exception)
	Read a set of RINEX observation files, filling a vector of SatPass objects.
int	SatPassToRinexFile (std::string filename, RinexObsHeader &header, std::vector< SatPass > &SPList) throw (Exception)
	Iterate over the input vector of SatPass objects (sorted to be in time order) and write them, with the given header, to a RINEX observation file of the given filename.