class FilterHit is used in stats to hold the filter results. The 'results' object used by the filters to indicate presence of 'events' : outlier(s), a slip or the beginning-of-data (BOD). Each filter's analyze() function returns a std::vector of one or more these objects; always with at least one element: the first is usually a BOD, but if there are outliers at the start, it can be type outlier. Calling the filter's getStats(FilterHit) will return statistics on the filter quantities (not the data) in the segment that begins at the event.
Definition at line 68 of file StatsFilterHit.hpp.
#include <StatsFilterHit.hpp>
Public Types | |
| typedef enum gnsstk::FilterHit::EventType | event |
| enum used to indicate the kind of event in this result More... | |
| enum | EventType { BOD = 0, outlier, slip, other } |
| enum used to indicate the kind of event in this result More... | |
Public Member Functions | |
| std::string | analMsg () const |
| return the analysis message More... | |
| std::string | asStatsString (const int osp=3) const |
| std::string | asString (const int osp=3) const |
| return as a single string with just type, index and npts More... | |
| std::string | asStringRead (const int osp=3) const |
| FilterHit () | |
| empty and only constructor More... | |
| bool | isBOD () |
| return true if this is BOD More... | |
| bool | isOutlier () |
| return true if this is outlier More... | |
| bool | isSlip () |
| return true if this is slip More... | |
Public Attributes | |
| T | dx |
| step in xdata: before SLIP or after OUT More... | |
| bool | haveStats |
| set true when getStats() is called More... | |
| unsigned int | index |
| index in the data array(s) at which this event occurs More... | |
| T | mad |
| robust stats on the filter quantities (not data) More... | |
| T | max |
| T | med |
| T | min |
| std::string | msg |
| message from analysis More... | |
| unsigned int | ngood |
| number of good (flag==0) points in this segment More... | |
| unsigned int | npts |
| number data points in segment (= a delta index) More... | |
| unsigned int | score |
| weight of slip (=100) More... | |
| T | sigma |
| for a slip, RSS future and past sigma on the data More... | |
| T | step |
| for a slip, an estimate of the step in the data More... | |
| event | type |
| type of event: BOD, outlier(s), slip, other More... | |
| typedef enum gnsstk::FilterHit::EventType gnsstk::FilterHit< T >::event |
enum used to indicate the kind of event in this result
| enum gnsstk::FilterHit::EventType |
enum used to indicate the kind of event in this result
| Enumerator | |
|---|---|
| BOD | beginning of data |
| outlier | outlier(s) - npts is the number of outliers |
| slip | slip (discontinuity) |
| other | never used? |
Definition at line 72 of file StatsFilterHit.hpp.
|
inline |
empty and only constructor
Definition at line 81 of file StatsFilterHit.hpp.
|
inline |
return the analysis message
Definition at line 118 of file StatsFilterHit.hpp.
|
inline |
return as a longer single string containing asString() plus stats
| osp | precision for fixed format |
Definition at line 197 of file StatsFilterHit.hpp.
|
inline |
return as a single string with just type, index and npts
Definition at line 121 of file StatsFilterHit.hpp.
|
inline |
return as a single human-readable string giving all the relevant info
| osp | precision for fixed format |
Definition at line 163 of file StatsFilterHit.hpp.
|
inline |
return true if this is BOD
Definition at line 109 of file StatsFilterHit.hpp.
|
inline |
return true if this is outlier
Definition at line 112 of file StatsFilterHit.hpp.
|
inline |
return true if this is slip
Definition at line 115 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::dx |
step in xdata: before SLIP or after OUT
Definition at line 100 of file StatsFilterHit.hpp.
| bool gnsstk::FilterHit< T >::haveStats |
set true when getStats() is called
Definition at line 102 of file StatsFilterHit.hpp.
| unsigned int gnsstk::FilterHit< T >::index |
index in the data array(s) at which this event occurs
Definition at line 91 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::mad |
robust stats on the filter quantities (not data)
Definition at line 104 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::max |
Definition at line 104 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::med |
Definition at line 104 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::min |
Definition at line 104 of file StatsFilterHit.hpp.
| std::string gnsstk::FilterHit< T >::msg |
message from analysis
Definition at line 106 of file StatsFilterHit.hpp.
| unsigned int gnsstk::FilterHit< T >::ngood |
number of good (flag==0) points in this segment
Definition at line 94 of file StatsFilterHit.hpp.
| unsigned int gnsstk::FilterHit< T >::npts |
number data points in segment (= a delta index)
Definition at line 93 of file StatsFilterHit.hpp.
| unsigned int gnsstk::FilterHit< T >::score |
weight of slip (=100)
Definition at line 96 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::sigma |
for a slip, RSS future and past sigma on the data
Definition at line 99 of file StatsFilterHit.hpp.
| T gnsstk::FilterHit< T >::step |
for a slip, an estimate of the step in the data
Definition at line 98 of file StatsFilterHit.hpp.
| event gnsstk::FilterHit< T >::type |
type of event: BOD, outlier(s), slip, other
Definition at line 88 of file StatsFilterHit.hpp.