Class OutlierDetectionSigma

Inheritance Relationships

Base Type

Class Documentation

class OutlierDetectionSigma : public navtk::utils::OutlierDetection

OutlierDetection algorithm which checks whether the current value is within sigma standard deviations relative to the other data points.

Callers use an OutlierDetectionSigma object by passing a navtk::Vector into the is_last_item_an_outlier method. This method returns true or false depending on whether the data point in question is within or outside of sigma standard deviations relative to the other data points.

Implementations of this class override is_last_item_an_outlier, which will be given a navtk::Vector of buffer_size length.

Public Functions

OutlierDetectionSigma(size_t buffer_size, double sigma)

Constructor.

Parameters

  • buffer_size – Determines the size of the ring buffer where data is stored for analysis

  • sigma – The sigma multiplier

virtual bool is_last_item_an_outlier(navtk::Vector const &data) const override

determines whether the value before is an outlier using the sigma multiplier

Parameters

data – Vector of values where data is stored for outlier analysis

Returns

boolean for whether the data is an outlier or not