Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Private Member Functions | Friends | List of all members
gnsstk::Arc Class Reference

Detailed Description

Class Arc encapsulates information for both break points in the data, due to gaps, slips and the initial point, and also for the segment of the data from this break to the next break. It includes start index, number of good and total number of points, stats and a mark giving type of segment and history ("GFslip", "outlier", "bad", "WLslipfixed", etc). There will always be an Arc with index==0 and type BEG to begin the data. Note that the only thing connecting the Arc to the data is the index; npts and ngood are computed using the map<index,Arc> Arcs and recomputeArcs()

Definition at line 82 of file gdc.hpp.

#include <gdc.hpp>

Classes

class  Arcinfo
 little class used to store information about one data array within this Arc More...
 

Public Member Functions

 Arc ()
 empty c'tor More...
 
 Arc (const Arc &right)
 copy constructor More...
 
 Arc (const FilterHit< double > &seg)
 create an Arc from a FilterHit (filters returns a vector of FilterHit) More...
 
 Arc (int ind, unsigned n, unsigned ng, unsigned m)
 c'tor with minimum info More...
 
std::string asString (const int prec=3) const
 
std::string brkString () const
 string giving brief summary of break info e.g. WLslip/GFslip/WLfix 445 pts 438 good More...
 
void init ()
 initialize (clear or empty) an Arc More...
 
std::string markString () const
 
Arcoperator= (const Arc &right)
 operator= More...
 

Static Public Member Functions

static std::string markString (const unsigned mark)
 convert one mark into a readable string More...
 

Public Attributes

Arcinfo GFinfo
 
int index
 index in data arrays of beginning ("break") More...
 
unsigned mark
 bitmap identifying actions that created or modified Arc More...
 
std::string message
 readable description of whatever More...
 
unsigned ngood
 number of good data points in the segment More...
 
unsigned npts
 number of points in the segment -> last index More...
 
Arcinfo WLinfo
 Arcinfo for each datatype. More...
 

Static Public Attributes

static const unsigned BEG = 1
 mark bitmap values for characterizing Arc: BEG, slips, fixes, etc; see init() More...
 
static const unsigned GFFIX = 16
 16 slip fixed on GF More...
 
static const unsigned GFMARK = 64
 32 slip suspected but not found on GF More...
 
static const unsigned GFSLIP = 4
 4 slip found on GF More...
 
static const std::map< unsigned, std::string > markStr = Arc::create_mark_string_map()
 strings describing values used for Arc::mark More...
 
static const unsigned REJ = 128
 128 segment of bad data - returnMessage() only More...
 
static const unsigned WLFIX = 8
 8 slip fixed on WL More...
 
static const unsigned WLMARK = 32
 64 slip suspected but not found on WL More...
 
static const unsigned WLSLIP = 2
 2 slip found on WL More...
 

Static Private Member Functions

static std::map< unsigned, std::string > create_mark_string_map ()
 helper routine to initialize markStr map More...
 

Friends

class gdc
 

Constructor & Destructor Documentation

◆ Arc() [1/4]

gnsstk::Arc::Arc ( )
inline

empty c'tor

Definition at line 163 of file gdc.hpp.

◆ Arc() [2/4]

gnsstk::Arc::Arc ( int  ind,
unsigned  n,
unsigned  ng,
unsigned  m 
)
inline

c'tor with minimum info

Definition at line 166 of file gdc.hpp.

◆ Arc() [3/4]

gnsstk::Arc::Arc ( const FilterHit< double > &  seg)
inline

create an Arc from a FilterHit (filters returns a vector of FilterHit)

Definition at line 187 of file gdc.hpp.

◆ Arc() [4/4]

gnsstk::Arc::Arc ( const Arc right)
inline

copy constructor

Definition at line 204 of file gdc.hpp.

Member Function Documentation

◆ asString()

std::string gnsstk::Arc::asString ( const int  prec = 3) const
inline

generate a string giving more extensive summary of the Arc e.g. WLslip/GFslip/WLfix/GFfix good/tot=438/445=98.43% dWL=46.5436wl NoAn dGF=-46.3682wl NoAn

Definition at line 268 of file gdc.hpp.

◆ brkString()

std::string gnsstk::Arc::brkString ( ) const
inline

string giving brief summary of break info e.g. WLslip/GFslip/WLfix 445 pts 438 good

Definition at line 254 of file gdc.hpp.

◆ create_mark_string_map()

static std::map<unsigned, std::string> gnsstk::Arc::create_mark_string_map ( )
inlinestaticprivate

helper routine to initialize markStr map

Definition at line 88 of file gdc.hpp.

◆ init()

void gnsstk::Arc::init ( )
inline

initialize (clear or empty) an Arc

Definition at line 176 of file gdc.hpp.

◆ markString() [1/2]

std::string gnsstk::Arc::markString ( ) const
inline

convert all marks in Arc.mark into a readable string e.g. Beg OR WLslip/GFslip/WLfix/GFfix

Definition at line 240 of file gdc.hpp.

◆ markString() [2/2]

static std::string gnsstk::Arc::markString ( const unsigned  mark)
inlinestatic

convert one mark into a readable string

Definition at line 224 of file gdc.hpp.

◆ operator=()

Arc& gnsstk::Arc::operator= ( const Arc right)
inline

operator=

Definition at line 211 of file gdc.hpp.

Friends And Related Function Documentation

◆ gdc

friend class gdc
friend

Definition at line 84 of file gdc.hpp.

Member Data Documentation

◆ BEG

const unsigned gnsstk::Arc::BEG = 1
static

mark bitmap values for characterizing Arc: BEG, slips, fixes, etc; see init()

1 beginning of data (beg-of-pass or after gap)

Definition at line 109 of file gdc.hpp.

◆ GFFIX

const unsigned gnsstk::Arc::GFFIX = 16
static

16 slip fixed on GF

Definition at line 113 of file gdc.hpp.

◆ GFinfo

Arcinfo gnsstk::Arc::GFinfo

Definition at line 155 of file gdc.hpp.

◆ GFMARK

const unsigned gnsstk::Arc::GFMARK = 64
static

32 slip suspected but not found on GF

Definition at line 114 of file gdc.hpp.

◆ GFSLIP

const unsigned gnsstk::Arc::GFSLIP = 4
static

4 slip found on GF

Definition at line 111 of file gdc.hpp.

◆ index

int gnsstk::Arc::index

index in data arrays of beginning ("break")

Definition at line 150 of file gdc.hpp.

◆ mark

unsigned gnsstk::Arc::mark

bitmap identifying actions that created or modified Arc

Definition at line 149 of file gdc.hpp.

◆ markStr

const map< unsigned, string > gnsstk::Arc::markStr = Arc::create_mark_string_map()
static

strings describing values used for Arc::mark

Definition at line 105 of file gdc.hpp.

◆ message

std::string gnsstk::Arc::message

readable description of whatever

Definition at line 157 of file gdc.hpp.

◆ ngood

unsigned gnsstk::Arc::ngood

number of good data points in the segment

Definition at line 152 of file gdc.hpp.

◆ npts

unsigned gnsstk::Arc::npts

number of points in the segment -> last index

Definition at line 151 of file gdc.hpp.

◆ REJ

const unsigned gnsstk::Arc::REJ = 128
static

128 segment of bad data - returnMessage() only

Definition at line 117 of file gdc.hpp.

◆ WLFIX

const unsigned gnsstk::Arc::WLFIX = 8
static

8 slip fixed on WL

Definition at line 112 of file gdc.hpp.

◆ WLinfo

Arcinfo gnsstk::Arc::WLinfo

Arcinfo for each datatype.

Definition at line 155 of file gdc.hpp.

◆ WLMARK

const unsigned gnsstk::Arc::WLMARK = 32
static

64 slip suspected but not found on WL

Definition at line 115 of file gdc.hpp.

◆ WLSLIP

const unsigned gnsstk::Arc::WLSLIP = 2
static

2 slip found on WL

Definition at line 110 of file gdc.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:44