Visual Servoing Platform  version 3.6.1 under development (2024-04-29)
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vpStatisticalTestShewhart Class Reference
core: Core module » Mathematics » Other tools

#include <visp3/core/vpStatisticalTestShewhart.h>

+ Inheritance diagram for vpStatisticalTestShewhart:

Public Types

enum  vpWecoRulesAlarm {
  THREE_SIGMA_WECO = 0 , TWO_SIGMA_WECO = 1 , ONE_SIGMA_WECO = 2 , SAME_SIDE_WECO = 3 ,
  NONE_WECO = 4 , COUNT_WECO = 5
}
 
typedef enum vpStatisticalTestShewhart::vpWecoRulesAlarm vpWecoRulesAlarm
 
enum  vpMeanDriftType {
  MEAN_DRIFT_NONE = 0 , MEAN_DRIFT_DOWNWARD = 1 , MEAN_DRIFT_UPWARD = 2 , MEAN_DRIFT_BOTH = 3 ,
  MEAN_DRIFT_COUNT = 4 , MEAN_DRIFT_UNKNOWN = MEAN_DRIFT_COUNT
}
 
typedef enum vpStatisticalTestAbstract::vpMeanDriftType vpMeanDriftType
 

Public Member Functions

 vpStatisticalTestShewhart (const bool &activateWECOrules=true, const bool activatedRules[COUNT_WECO - 1]=CONST_ALL_WECO_ACTIVATED, const unsigned int &nbSamplesForStats=30)
 
 vpStatisticalTestShewhart (const bool &activateWECOrules, const bool activatedRules[COUNT_WECO - 1], const float &mean, const float &stdev)
 
vpWecoRulesAlarm getAlarm () const
 
virtual float getSignal () const override
 
std::vector< float > getSignals () const
 
void init (const bool &activateWECOrules, const bool activatedRules[COUNT_WECO - 1]=CONST_ALL_WECO_ACTIVATED, const unsigned int &nbSamplesForStats=30)
 
void init (const bool &activateWECOrules, const bool activatedRules[COUNT_WECO - 1], const float &mean, const float &stdev)
 
void init (const float &h=3.f, const unsigned int &nbSamplesForStats=30)
 
void init (const float &h, const float &mean, const float &stdev)
 
void init ()
 
void getLimits (float &limitDown, float &limitUp) const
 
float getMean () const
 
float getStdev () const
 
void setMinStdev (const float &stdevmin)
 
void setNbSamplesForStat (const unsigned int &nbSamples)
 
vpMeanDriftType testDownUpwardMeanDrift (const float &signal)
 
vpMeanDriftType testDownwardMeanDrift (const float &signal)
 
vpMeanDriftType testUpwardMeanDrift (const float &signal)
 

Static Public Member Functions

static std::string vpWecoRulesAlarmToString (const vpWecoRulesAlarm &alarm)
 
static std::string vpMeanDriftTypeToString (const vpMeanDriftType &type)
 
static vpMeanDriftType vpMeanDriftTypeFromString (const std::string &name)
 
static std::string getAvailableMeanDriftType (const std::string &prefix="<", const std::string &sep=" , ", const std::string &suffix=">")
 
static void print (const vpMeanDriftType &type)
 

Static Public Attributes

static const bool CONST_ALL_WECO_ACTIVATED [COUNT_WECO - 1] = { true, true, true, true }
 
static const int NB_DATA_SIGNAL = 8
 

Protected Member Functions

virtual void computeLimits () override
 
virtual vpMeanDriftType detectDownwardMeanDrift () override
 
virtual vpMeanDriftType detectUpwardMeanDrift () override
 
virtual bool updateStatistics (const float &signal) override
 
virtual void updateTestSignals (const float &signal) override
 

Protected Attributes

unsigned int m_nbDataInBuffer
 
float m_signal [NB_DATA_SIGNAL]
 
bool m_activateWECOrules
 
bool m_activatedWECOrules [COUNT_WECO - 1]
 
int m_idCurrentData
 
vpWecoRulesAlarm m_alarm
 
float m_oneSigmaNegLim
 
float m_oneSigmaPosLim
 
float m_twoSigmaNegLim
 
float m_twoSigmaPosLim
 
float m_h
 
float m_s
 
bool m_areStatisticsComputed
 
float m_count
 
float m_limitDown
 
float m_limitUp
 
float m_mean
 
unsigned int m_nbSamplesForStatistics
 
float m_stdev
 
float m_stdevmin
 
float m_sumForMean
 

Detailed Description

Class that permits a Shewhart's test.

Be $ s(t) $ the signal to monitor, $ \mu $ and $ \sigma $ the mean and standard deviation of this signal when it is "in control".

A downward alarm is raised if: $ s(t) >= \mu - 3 \sigma $

An upward alarm is raised if: $ s(t) >= \mu + 3 \sigma $

Additionnally, we can activate the WECO's rules that have been proposed by the Western Electric Company to add additionnal verifications:

  • An alarm is raised if two out of three consecutive points fall beyond the $2\sigma$-limit, on the same side of the mean $ \mu $
  • An alarm is raised if four out of five consecutive points fall beyond the $1\sigma$-limit, on the same side of the mean $ \mu $
  • An alarm is raised if eight consecutive points fall on the same side of the mean $ \mu $.

The user can decide to use or not the WECO's rules. Additionnally, the user can choose which WECO's rule(s) to activate.

To detect only downward drifts of the input signal $ s(t) $ use testDownwardMeanDrift().To detect only upward drifts in $ s(t) $ use testUpwardMeanDrift(). To detect both, downward and upward drifts use testDownUpwardMeanDrift().

Examples
testSPC.cpp, and tutorial-meandrift.cpp.

Definition at line 73 of file vpStatisticalTestShewhart.h.

Member Typedef Documentation

◆ vpMeanDriftType

typedef enum vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestAbstract::vpMeanDriftType
inherited

Enum that indicates if a drift of the mean occurred.

◆ vpWecoRulesAlarm

typedef enum vpStatisticalTestShewhart::vpWecoRulesAlarm vpStatisticalTestShewhart::vpWecoRulesAlarm

Member Enumeration Documentation

◆ vpMeanDriftType

enum vpStatisticalTestAbstract::vpMeanDriftType
inherited

Enum that indicates if a drift of the mean occurred.

Enumerator
MEAN_DRIFT_NONE 

No mean drift occurred

MEAN_DRIFT_DOWNWARD 

A downward drift of the mean occurred.

MEAN_DRIFT_UPWARD 

An upward drift of the mean occurred.

MEAN_DRIFT_BOTH 

Both an aupward and a downward drifts occurred.

MEAN_DRIFT_COUNT 
MEAN_DRIFT_UNKNOWN 

Definition at line 62 of file vpStatisticalTestAbstract.h.

◆ vpWecoRulesAlarm

enum vpStatisticalTestShewhart::vpWecoRulesAlarm
Enumerator
THREE_SIGMA_WECO 

When a $ 3\sigma $ alarm was raised.

TWO_SIGMA_WECO 

When a $ 2\sigma $ alarm was raised.

ONE_SIGMA_WECO 

When a $ 1\sigma $ alarm was raised

SAME_SIDE_WECO 

When a alarm raised when 8 consecutive points lie on the same side of the mean $ \mu $ was raised.

NONE_WECO 

When no WECO's rule alarm was raised.

COUNT_WECO 

Number of WECO's rules that are implemented.

Definition at line 76 of file vpStatisticalTestShewhart.h.

Constructor & Destructor Documentation

◆ vpStatisticalTestShewhart() [1/2]

vpStatisticalTestShewhart::vpStatisticalTestShewhart ( const bool &  activateWECOrules = true,
const bool  activatedRules[COUNT_WECO - 1] = CONST_ALL_WECO_ACTIVATED,
const unsigned int &  nbSamplesForStats = 30 
)

Construct a new vpStatisticalTestShewhart object.

Parameters
[in]activateWECOrulesIf true, activate the WECO's rules (NB: it increases the sensitivity of the Shewhart control chart but the false alarm frequency is also increased.)
[in]activatedRulesAn array where true means that the corresponding WECO's rule is activated and false means that it is not.
[in]nbSamplesForStatsThe number of samples to compute the statistics of the signal.

Definition at line 248 of file vpStatisticalTestShewhart.cpp.

References vpStatisticalTestAbstract::init().

◆ vpStatisticalTestShewhart() [2/2]

vpStatisticalTestShewhart::vpStatisticalTestShewhart ( const bool &  activateWECOrules,
const bool  activatedRules[COUNT_WECO - 1],
const float &  mean,
const float &  stdev 
)

Construct a new vpStatisticalTestShewhart object.

Parameters
[in]activateWECOrulesIf true, activate the WECO's rules (NB: it increases the sensitivity of the Shewhart control chart but the false alarm frequency is also increased.)
[in]activatedRulesAn array where true means that the corresponding WECO's rule is activated and false means that it is not.
[in]meanThe expected mean of the signal.
[in]stdevThe expected standard deviation of the signal.

Definition at line 262 of file vpStatisticalTestShewhart.cpp.

References vpStatisticalTestAbstract::init().

Member Function Documentation

◆ computeLimits()

void vpStatisticalTestShewhart::computeLimits ( )
overrideprotectedvirtual

Compute the upper and lower limits of the test signal.

Reimplemented from vpStatisticalTestSigma.

Definition at line 74 of file vpStatisticalTestShewhart.cpp.

References vpStatisticalTestAbstract::m_limitDown, vpStatisticalTestAbstract::m_limitUp, vpStatisticalTestAbstract::m_mean, m_oneSigmaNegLim, m_oneSigmaPosLim, vpStatisticalTestAbstract::m_stdev, m_twoSigmaNegLim, and m_twoSigmaPosLim.

Referenced by init(), and updateStatistics().

◆ detectDownwardMeanDrift()

vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestShewhart::detectDownwardMeanDrift ( )
overrideprotectedvirtual

Detects if a downward mean drift occured.

Returns
vpMeanDriftType::MEAN_DRIFT_DOWNWARD if a downward mean drift occured, vpMeanDriftType::MEAN_DRIFT_NONE otherwise.
See also
detectUpwardMeanDrift()

Reimplemented from vpStatisticalTestSigma.

Definition at line 85 of file vpStatisticalTestShewhart.cpp.

References m_activatedWECOrules, m_activateWECOrules, m_alarm, m_idCurrentData, vpStatisticalTestAbstract::m_limitDown, vpStatisticalTestAbstract::m_mean, m_nbDataInBuffer, m_oneSigmaNegLim, m_signal, m_twoSigmaNegLim, vpStatisticalTestAbstract::MEAN_DRIFT_DOWNWARD, vpStatisticalTestAbstract::MEAN_DRIFT_NONE, vpMath::modulo(), NB_DATA_SIGNAL, ONE_SIGMA_WECO, SAME_SIDE_WECO, THREE_SIGMA_WECO, and TWO_SIGMA_WECO.

◆ detectUpwardMeanDrift()

vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestShewhart::detectUpwardMeanDrift ( )
overrideprotectedvirtual

Detects if an upward mean drift occured on the mean.

Returns
vpMeanDriftType::MEAN_DRIFT_UPWARD if an upward mean drift occured, vpMeanDriftType::MEAN_DRIFT_NONE otherwise.
See also
detectDownwardMeanDrift()

Reimplemented from vpStatisticalTestSigma.

Definition at line 157 of file vpStatisticalTestShewhart.cpp.

References m_activatedWECOrules, m_activateWECOrules, m_alarm, m_idCurrentData, vpStatisticalTestAbstract::m_limitUp, vpStatisticalTestAbstract::m_mean, m_nbDataInBuffer, m_oneSigmaPosLim, m_signal, m_twoSigmaPosLim, vpStatisticalTestAbstract::MEAN_DRIFT_NONE, vpStatisticalTestAbstract::MEAN_DRIFT_UPWARD, vpMath::modulo(), NB_DATA_SIGNAL, ONE_SIGMA_WECO, SAME_SIDE_WECO, THREE_SIGMA_WECO, and TWO_SIGMA_WECO.

◆ getAlarm()

vpWecoRulesAlarm vpStatisticalTestShewhart::getAlarm ( ) const
inline

Get the alarm raised by the last test due to the WECO's rules.

Returns
vpWecoRulesAlarm The type of raised alarm.
Examples
tutorial-meandrift.cpp.

Definition at line 192 of file vpStatisticalTestShewhart.h.

◆ getAvailableMeanDriftType()

std::string vpStatisticalTestAbstract::getAvailableMeanDriftType ( const std::string &  prefix = "<",
const std::string &  sep = " , ",
const std::string &  suffix = ">" 
)
staticinherited

Get the list of available vpMeanDriftType objects that are handled.

Parameters
[in]prefixThe prefix that should be placed before the list.
[in]sepThe separator between each element of the list.
[in]suffixThe suffix that should terminate the list.
Returns
std::string The list of handled type of process tests, presented as a string.
Examples
tutorial-meandrift.cpp.

Definition at line 82 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::MEAN_DRIFT_COUNT, and vpStatisticalTestAbstract::vpMeanDriftTypeToString().

◆ getLimits()

void vpStatisticalTestAbstract::getLimits ( float &  limitDown,
float &  limitUp 
) const
inlineinherited

Get the upper and lower limits of the test signal.

Parameters
[out]limitDownThe lower limit.
[out]limitUpThe upper limit.
Examples
testSPC.cpp, and tutorial-meandrift.cpp.

Definition at line 174 of file vpStatisticalTestAbstract.h.

◆ getMean()

float vpStatisticalTestAbstract::getMean ( ) const
inlineinherited

Get the mean used as reference.

Returns
float The mean.
Examples
tutorial-meandrift.cpp.

Definition at line 185 of file vpStatisticalTestAbstract.h.

◆ getSignal()

virtual float vpStatisticalTestShewhart::getSignal ( ) const
inlineoverridevirtual

Get the last value of the signal.

Returns
float The signal.

Reimplemented from vpStatisticalTestSigma.

Examples
testSPC.cpp.

Definition at line 203 of file vpStatisticalTestShewhart.h.

◆ getSignals()

std::vector< float > vpStatisticalTestShewhart::getSignals ( ) const

Get the NB_DATA_SIGNAL last signal values, sorted from the latest [0] to the newest [NB_DATA_SIGNAL - 1].

Returns
std::vector<float> The last NB_DATA_SIGNAL values.
Examples
tutorial-meandrift.cpp.

Definition at line 276 of file vpStatisticalTestShewhart.cpp.

References m_idCurrentData, m_signal, vpMath::modulo(), and NB_DATA_SIGNAL.

◆ getStdev()

float vpStatisticalTestAbstract::getStdev ( ) const
inlineinherited

Get the standard deviation used as reference.

Returns
float The standard deviation.
Examples
tutorial-meandrift.cpp.

Definition at line 195 of file vpStatisticalTestAbstract.h.

◆ init() [1/5]

void vpStatisticalTestAbstract::init ( )
inherited

(Re)Initialize the algorithm.

Definition at line 154 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::m_areStatisticsComputed, vpStatisticalTestAbstract::m_count, vpStatisticalTestAbstract::m_limitDown, vpStatisticalTestAbstract::m_limitUp, vpStatisticalTestAbstract::m_mean, vpStatisticalTestAbstract::m_nbSamplesForStatistics, vpStatisticalTestAbstract::m_s, vpStatisticalTestAbstract::m_stdev, and vpStatisticalTestAbstract::m_sumForMean.

Referenced by vpStatisticalTestHinkley::init(), init(), vpStatisticalTestEWMA::init(), vpStatisticalTestMeanAdjustedCUSUM::init(), vpStatisticalTestSigma::init(), vpStatisticalTestEWMA::setAlpha(), vpStatisticalTestEWMA::vpStatisticalTestEWMA(), vpStatisticalTestMeanAdjustedCUSUM::vpStatisticalTestMeanAdjustedCUSUM(), vpStatisticalTestShewhart(), and vpStatisticalTestSigma::vpStatisticalTestSigma().

◆ init() [2/5]

void vpStatisticalTestShewhart::init ( const bool &  activateWECOrules,
const bool  activatedRules[COUNT_WECO - 1],
const float &  mean,
const float &  stdev 
)

(Re)Initialize the test.

Parameters
[in]activateWECOrulesIf true, activate the WECO's rules (NB: it increases the sensitivity of the Shewhart control chart but the false alarm frequency is also increased.)
[in]activatedRulesAn array where true means that the corresponding WECO's rule is activated and false means that it is not.
[in]meanThe expected mean of the signal.
[in]stdevThe expected standard deviation of the signal.

Definition at line 301 of file vpStatisticalTestShewhart.cpp.

References computeLimits(), vpStatisticalTestAbstract::init(), vpStatisticalTestAbstract::m_areStatisticsComputed, vpStatisticalTestAbstract::m_mean, and vpStatisticalTestAbstract::m_stdev.

◆ init() [3/5]

void vpStatisticalTestShewhart::init ( const bool &  activateWECOrules,
const bool  activatedRules[COUNT_WECO - 1] = CONST_ALL_WECO_ACTIVATED,
const unsigned int &  nbSamplesForStats = 30 
)

(Re)Initialize the test.

Parameters
[in]activateWECOrulesIf true, activate the WECO's rules (NB: it increases the sensitivity of the Shewhart control chart but the false alarm frequency is also increased.)
[in]activatedRulesAn array where true means that the corresponding WECO's rule is activated and false means that it is not.
[in]nbSamplesForStatsThe number of samples to compute the statistics of the signal.
Examples
testSPC.cpp.

Definition at line 286 of file vpStatisticalTestShewhart.cpp.

References COUNT_WECO, vpStatisticalTestAbstract::init(), m_activatedWECOrules, m_activateWECOrules, m_alarm, m_idCurrentData, m_nbDataInBuffer, m_oneSigmaNegLim, m_oneSigmaPosLim, m_signal, m_twoSigmaNegLim, m_twoSigmaPosLim, NB_DATA_SIGNAL, and NONE_WECO.

◆ init() [4/5]

void vpStatisticalTestSigma::init ( const float &  h,
const float &  mean,
const float &  stdev 
)
inherited

(Re)Initialize the test.

Parameters
[in]hThe alarm factor applied to the standard deviation to compute the limits.
[in]meanThe expected mean of the signal.
[in]stdevThe expected standard deviation of the signal.

Definition at line 105 of file vpStatisticalTestSigma.cpp.

References vpStatisticalTestSigma::computeLimits(), vpStatisticalTestAbstract::init(), vpStatisticalTestAbstract::m_areStatisticsComputed, vpStatisticalTestSigma::m_h, vpStatisticalTestAbstract::m_mean, vpStatisticalTestSigma::m_s, and vpStatisticalTestAbstract::m_stdev.

◆ init() [5/5]

void vpStatisticalTestSigma::init ( const float &  h = 3.f,
const unsigned int &  nbSamplesForStats = 30 
)
inherited

(Re)Initialize the test.

Parameters
[in]hThe alarm factor applied to the standard deviation to compute the limits.
[in]nbSamplesForStatsThe number of samples to compute the statistics of the signal.

Definition at line 97 of file vpStatisticalTestSigma.cpp.

References vpStatisticalTestAbstract::init(), vpStatisticalTestSigma::m_h, vpStatisticalTestSigma::m_s, and vpStatisticalTestAbstract::setNbSamplesForStat().

◆ print()

void vpStatisticalTestAbstract::print ( const vpMeanDriftType &  type)
staticinherited

Print the message corresponding to the type of mean drift.

Parameters
[in]typeThe type of mean drift.

Definition at line 95 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::vpMeanDriftTypeToString().

◆ setMinStdev()

void vpStatisticalTestAbstract::setMinStdev ( const float &  stdevmin)
inlineinherited

Set the minimum value of the standard deviation that is expected. The computed standard deviation cannot be lower this value if set.

Parameters
[in]stdevminThe minimum value of the standard deviation that is expected.

Definition at line 219 of file vpStatisticalTestAbstract.h.

◆ setNbSamplesForStat()

void vpStatisticalTestAbstract::setNbSamplesForStat ( const unsigned int &  nbSamples)
inherited

Set the number of samples required to compute the mean and standard deviation of the signal and allocate the memory accordingly.

Parameters
[in]nbSamplesThe number of samples we want to use.

Definition at line 190 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::m_nbSamplesForStatistics, and vpStatisticalTestAbstract::m_s.

Referenced by vpStatisticalTestHinkley::init(), vpStatisticalTestEWMA::init(), vpStatisticalTestMeanAdjustedCUSUM::init(), vpStatisticalTestSigma::init(), and vpStatisticalTestAbstract::operator=().

◆ testDownUpwardMeanDrift()

vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestAbstract::testDownUpwardMeanDrift ( const float &  signal)
inherited

Test if a downward or an upward mean drift occurred according to the new value of the signal.

Parameters
[in]signalThe new value of the signal.
Returns
vpMeanDriftType The type of mean drift that occurred.
See also
testDownwardMeanDrift() testUpwardMeanDrift()
Examples
testSPC.cpp, and tutorial-meandrift.cpp.

Definition at line 199 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::detectDownwardMeanDrift(), vpStatisticalTestAbstract::detectUpwardMeanDrift(), vpStatisticalTestAbstract::m_areStatisticsComputed, vpStatisticalTestAbstract::MEAN_DRIFT_BOTH, vpStatisticalTestAbstract::MEAN_DRIFT_NONE, vpStatisticalTestAbstract::updateStatistics(), and vpStatisticalTestAbstract::updateTestSignals().

◆ testDownwardMeanDrift()

vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestAbstract::testDownwardMeanDrift ( const float &  signal)
inherited

Test if a downward mean drift occurred according to the new value of the signal.

Parameters
[in]signalThe new value of the signal.
Returns
vpMeanDriftType The type of mean drift that occurred.
See also
testUpwardMeanDrift()

Definition at line 224 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::detectDownwardMeanDrift(), vpStatisticalTestAbstract::m_areStatisticsComputed, vpStatisticalTestAbstract::MEAN_DRIFT_NONE, vpStatisticalTestAbstract::updateStatistics(), and vpStatisticalTestAbstract::updateTestSignals().

◆ testUpwardMeanDrift()

vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestAbstract::testUpwardMeanDrift ( const float &  signal)
inherited

Test if an upward mean drift occurred according to the new value of the signal.

Parameters
[in]signalThe new value of the signal.
Returns
vpMeanDriftType The type of mean drift that occurred.
See also
testDownwardMeanDrift()

Definition at line 236 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::detectUpwardMeanDrift(), vpStatisticalTestAbstract::m_areStatisticsComputed, vpStatisticalTestAbstract::MEAN_DRIFT_NONE, vpStatisticalTestAbstract::updateStatistics(), and vpStatisticalTestAbstract::updateTestSignals().

◆ updateStatistics()

bool vpStatisticalTestShewhart::updateStatistics ( const float &  signal)
overrideprotectedvirtual

Update m_s and if enough values are available, compute the mean, the standard deviation and the limits.

Parameters
[in]signalThe new value of the signal to monitor.

Reimplemented from vpStatisticalTestSigma.

Definition at line 229 of file vpStatisticalTestShewhart.cpp.

References computeLimits(), vpStatisticalTestAbstract::updateStatistics(), and updateTestSignals().

◆ updateTestSignals()

void vpStatisticalTestShewhart::updateTestSignals ( const float &  signal)
overrideprotectedvirtual

Update the test signals.

Parameters
[in]signalThe new value of the signal to monitor.

Reimplemented from vpStatisticalTestSigma.

Definition at line 239 of file vpStatisticalTestShewhart.cpp.

References m_idCurrentData, m_nbDataInBuffer, m_signal, and NB_DATA_SIGNAL.

Referenced by updateStatistics().

◆ vpMeanDriftTypeFromString()

vpStatisticalTestAbstract::vpMeanDriftType vpStatisticalTestAbstract::vpMeanDriftTypeFromString ( const std::string &  name)
staticinherited

Cast a string into a vpMeanDriftType.

Parameters
[in]nameThe name of the mean drift.
Returns
vpMeanDriftType The corresponding vpMeanDriftType.
Examples
tutorial-meandrift.cpp.

Definition at line 65 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::MEAN_DRIFT_COUNT, vpStatisticalTestAbstract::MEAN_DRIFT_UNKNOWN, and vpStatisticalTestAbstract::vpMeanDriftTypeToString().

Referenced by TutorialMeanDrift::vectorOfStringToMeanDriftTypeArray().

◆ vpMeanDriftTypeToString()

std::string vpStatisticalTestAbstract::vpMeanDriftTypeToString ( const vpMeanDriftType &  type)
staticinherited

Cast a vpMeanDriftType into a string.

Parameters
[in]typeThe type of mean drift.
Returns
std::string The corresponding message.
Examples
testSPC.cpp, and tutorial-meandrift.cpp.

Definition at line 41 of file vpStatisticalTestAbstract.cpp.

References vpStatisticalTestAbstract::MEAN_DRIFT_BOTH, vpStatisticalTestAbstract::MEAN_DRIFT_DOWNWARD, vpStatisticalTestAbstract::MEAN_DRIFT_NONE, vpStatisticalTestAbstract::MEAN_DRIFT_UNKNOWN, and vpStatisticalTestAbstract::MEAN_DRIFT_UPWARD.

Referenced by vpStatisticalTestAbstract::getAvailableMeanDriftType(), TutorialMeanDrift::meanDriftArrayToVectorOfString(), vpStatisticalTestAbstract::print(), and vpStatisticalTestAbstract::vpMeanDriftTypeFromString().

◆ vpWecoRulesAlarmToString()

std::string vpStatisticalTestShewhart::vpWecoRulesAlarmToString ( const vpWecoRulesAlarm &  alarm)
static
Examples
testSPC.cpp, and tutorial-meandrift.cpp.

Definition at line 49 of file vpStatisticalTestShewhart.cpp.

References NONE_WECO, ONE_SIGMA_WECO, SAME_SIDE_WECO, THREE_SIGMA_WECO, and TWO_SIGMA_WECO.

Member Data Documentation

◆ CONST_ALL_WECO_ACTIVATED

const bool vpStatisticalTestShewhart::CONST_ALL_WECO_ACTIVATED = { true, true, true, true }
static
Examples
testSPC.cpp, and tutorial-meandrift.cpp.

Definition at line 88 of file vpStatisticalTestShewhart.h.

Referenced by TutorialMeanDrift::ParametersForAlgo::ParametersForAlgo().

◆ m_activatedWECOrules

bool vpStatisticalTestShewhart::m_activatedWECOrules[COUNT_WECO - 1]
protected

The WECO's rules that are activated. The more are activated, the higher the sensitivity of the Shewhart control chart is but the higher the false alarm frequency is.

Definition at line 96 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), and init().

◆ m_activateWECOrules

bool vpStatisticalTestShewhart::m_activateWECOrules
protected

If true, activate the WECO's rules (NB: it increases the sensitivity of the Shewhart control chart but the false alarm frequency is also increased.)

Definition at line 94 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), and init().

◆ m_alarm

vpWecoRulesAlarm vpStatisticalTestShewhart::m_alarm
protected

The type of alarm raised due to WECO's rules.

Definition at line 100 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), and init().

◆ m_areStatisticsComputed

bool vpStatisticalTestAbstract::m_areStatisticsComputed
protectedinherited

Set to true once the mean and the standard deviation are available.

Definition at line 107 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestAbstract::init(), init(), vpStatisticalTestHinkley::init(), vpStatisticalTestEWMA::init(), vpStatisticalTestMeanAdjustedCUSUM::init(), vpStatisticalTestSigma::init(), vpStatisticalTestAbstract::operator=(), vpStatisticalTestAbstract::testDownUpwardMeanDrift(), vpStatisticalTestAbstract::testDownwardMeanDrift(), vpStatisticalTestAbstract::testUpwardMeanDrift(), vpStatisticalTestAbstract::updateStatistics(), and vpStatisticalTestHinkley::updateStatistics().

◆ m_count

float vpStatisticalTestAbstract::m_count
protectedinherited

Current number of data used to compute the mean and the standard deviation.

Definition at line 108 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestHinkley::computeMean(), vpStatisticalTestAbstract::init(), vpStatisticalTestAbstract::operator=(), vpStatisticalTestAbstract::updateStatistics(), and vpStatisticalTestHinkley::updateTestSignals().

◆ m_h

float vpStatisticalTestSigma::m_h
protectedinherited

The alarm factor applied to the standard deviation to compute the limits.

Definition at line 71 of file vpStatisticalTestSigma.h.

Referenced by vpStatisticalTestSigma::computeLimits(), and vpStatisticalTestSigma::init().

◆ m_idCurrentData

int vpStatisticalTestShewhart::m_idCurrentData
protected

The index of the current data in m_signal.

Definition at line 99 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), getSignals(), init(), and updateTestSignals().

◆ m_limitDown

float vpStatisticalTestAbstract::m_limitDown
protectedinherited

Upper limit for the test signal m_wt.

Definition at line 109 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestEWMA::computeDeltaAndLimits(), vpStatisticalTestSigma::computeLimits(), computeLimits(), vpStatisticalTestEWMA::detectDownwardMeanDrift(), vpStatisticalTestMeanAdjustedCUSUM::detectDownwardMeanDrift(), detectDownwardMeanDrift(), vpStatisticalTestSigma::detectDownwardMeanDrift(), vpStatisticalTestAbstract::init(), vpStatisticalTestAbstract::operator=(), vpStatisticalTestHinkley::setAlpha(), and vpStatisticalTestMeanAdjustedCUSUM::updateStatistics().

◆ m_limitUp

float vpStatisticalTestAbstract::m_limitUp
protectedinherited

Lower limit for the test signal m_wt

Definition at line 110 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestEWMA::computeDeltaAndLimits(), vpStatisticalTestSigma::computeLimits(), computeLimits(), vpStatisticalTestEWMA::detectUpwardMeanDrift(), vpStatisticalTestMeanAdjustedCUSUM::detectUpwardMeanDrift(), detectUpwardMeanDrift(), vpStatisticalTestSigma::detectUpwardMeanDrift(), vpStatisticalTestAbstract::init(), vpStatisticalTestAbstract::operator=(), vpStatisticalTestHinkley::setAlpha(), and vpStatisticalTestMeanAdjustedCUSUM::updateStatistics().

◆ m_mean

float vpStatisticalTestAbstract::m_mean
protectedinherited

Mean of the monitored signal.

Definition at line 111 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestEWMA::computeDeltaAndLimits(), vpStatisticalTestSigma::computeLimits(), computeLimits(), vpStatisticalTestHinkley::computeMean(), vpStatisticalTestHinkley::computeSk(), vpStatisticalTestHinkley::computeTk(), detectDownwardMeanDrift(), detectUpwardMeanDrift(), vpStatisticalTestAbstract::init(), init(), vpStatisticalTestHinkley::init(), vpStatisticalTestEWMA::init(), vpStatisticalTestMeanAdjustedCUSUM::init(), vpStatisticalTestSigma::init(), vpStatisticalTestAbstract::operator=(), vpStatisticalTestAbstract::updateStatistics(), vpStatisticalTestEWMA::updateStatistics(), and vpStatisticalTestMeanAdjustedCUSUM::updateTestSignals().

◆ m_nbDataInBuffer

unsigned int vpStatisticalTestShewhart::m_nbDataInBuffer
protected

Indicate how many data are available in the circular buffer.

Definition at line 92 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), init(), and updateTestSignals().

◆ m_nbSamplesForStatistics

unsigned int vpStatisticalTestAbstract::m_nbSamplesForStatistics
protectedinherited

Number of samples to use to compute the mean and the standard deviation.

Definition at line 112 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestAbstract::init(), vpStatisticalTestAbstract::operator=(), vpStatisticalTestAbstract::setNbSamplesForStat(), and vpStatisticalTestAbstract::updateStatistics().

◆ m_oneSigmaNegLim

float vpStatisticalTestShewhart::m_oneSigmaNegLim
protected

The $ \mu - \sigma $ threshold.

Definition at line 101 of file vpStatisticalTestShewhart.h.

Referenced by computeLimits(), detectDownwardMeanDrift(), and init().

◆ m_oneSigmaPosLim

float vpStatisticalTestShewhart::m_oneSigmaPosLim
protected

The $ \mu + \sigma $ threshold.

Definition at line 102 of file vpStatisticalTestShewhart.h.

Referenced by computeLimits(), detectUpwardMeanDrift(), and init().

◆ m_s

float vpStatisticalTestSigma::m_s
protectedinherited

The last value of the signal.

Definition at line 72 of file vpStatisticalTestSigma.h.

Referenced by vpStatisticalTestSigma::detectDownwardMeanDrift(), vpStatisticalTestSigma::detectUpwardMeanDrift(), vpStatisticalTestSigma::init(), and vpStatisticalTestSigma::updateTestSignals().

◆ m_signal

float vpStatisticalTestShewhart::m_signal[NB_DATA_SIGNAL]
protected

The last values of the signal.

Definition at line 93 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), getSignals(), init(), and updateTestSignals().

◆ m_stdev

float vpStatisticalTestAbstract::m_stdev
protectedinherited

Standard deviation of the monitored signal.

Definition at line 114 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestHinkley::computeAlphaDelta(), vpStatisticalTestEWMA::computeDeltaAndLimits(), vpStatisticalTestMeanAdjustedCUSUM::computeDeltaAndLimits(), vpStatisticalTestSigma::computeLimits(), computeLimits(), vpStatisticalTestAbstract::init(), init(), vpStatisticalTestEWMA::init(), vpStatisticalTestHinkley::init(), vpStatisticalTestMeanAdjustedCUSUM::init(), vpStatisticalTestSigma::init(), vpStatisticalTestAbstract::operator=(), and vpStatisticalTestAbstract::updateStatistics().

◆ m_stdevmin

float vpStatisticalTestAbstract::m_stdevmin
protectedinherited

Minimum allowed standard deviation of the monitored signal.

Definition at line 115 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestAbstract::updateStatistics().

◆ m_sumForMean

float vpStatisticalTestAbstract::m_sumForMean
protectedinherited

Sum of the samples used to compute the mean and standard deviation.

Definition at line 116 of file vpStatisticalTestAbstract.h.

Referenced by vpStatisticalTestAbstract::init(), vpStatisticalTestMeanAdjustedCUSUM::init(), vpStatisticalTestAbstract::operator=(), and vpStatisticalTestAbstract::updateStatistics().

◆ m_twoSigmaNegLim

float vpStatisticalTestShewhart::m_twoSigmaNegLim
protected

The $ \mu - 2 \sigma $ threshold.

Definition at line 103 of file vpStatisticalTestShewhart.h.

Referenced by computeLimits(), detectDownwardMeanDrift(), and init().

◆ m_twoSigmaPosLim

float vpStatisticalTestShewhart::m_twoSigmaPosLim
protected

The $ \mu + 2 \sigma $ threshold.

Definition at line 104 of file vpStatisticalTestShewhart.h.

Referenced by computeLimits(), detectUpwardMeanDrift(), and init().

◆ NB_DATA_SIGNAL

const int vpStatisticalTestShewhart::NB_DATA_SIGNAL = 8
static
Examples
testSPC.cpp.

Definition at line 89 of file vpStatisticalTestShewhart.h.

Referenced by detectDownwardMeanDrift(), detectUpwardMeanDrift(), getSignals(), init(), and updateTestSignals().