FLImaging 6.5.8.1
FLImaging::Foundation::CStatistics< T > Class Template Reference

A class that computes statistics based on the values of elements in CFLArray. Support types. More...

#include <Statistics.h>

Inheritance diagram for FLImaging::Foundation::CStatistics< T >:
FLImaging::Base::CFLBase

Public Member Functions

virtual ~CStatistics ()
 
- Public Member Functions inherited from FLImaging::Base::CFLBase
 CFLBase ()
 Default constructor.
 
virtual ~CFLBase ()
 Destructor.
 
void Lock () const
 Set a lock on an object.
 
bool TryLock () const
 Try to lock the object.
 
void Unlock () const
 Unlock the object.
 
virtual const CProcessingUnitBaseGetProcessingUnit () const
 Returns the set ProcessingUnit.
 
virtual const CResult SetProcessingUnit (const CProcessingUnitBase &pub)
 set the ProcessingUnit
 
virtual const CResult SetProcessingUnit (const CProcessingUnitBase *pPub)
 Set the ProcessingUnit.
 
virtual void ResetProcessingUnit ()
 Rest the ProcessingUnit.
 
virtual bool IsValid () const
 Validate the object.
 
template<class T >
bool IsValid (T &tValue) const
 Validate input values.
 
template<class T >
bool IsValid (T *pTValue) const
 Validate input values.
 
template<class T >
void GenerateMin (T &tValue) const
 Generate the minimum value of that type.
 
template<class T >
void GenerateMin (T *pTValue) const
 Generate the minimum value of that type.
 
template<class T >
void GenerateMinInt32 (T &tValue) const
 Generate minimum signed 32-bit integer value.
 
template<class T >
void GenerateMinInt32 (T *pTValue) const
 Generate minimum signed 32-bit integer value.
 
template<class T >
void GenerateMinInt31 (T &tValue) const
 Generate minimum signed 31-bit integer value.
 
template<class T >
void GenerateMinInt31 (T *pTValue) const
 Generate minimum signed 31-bit integer value.
 
template<class T >
void GenerateMax (T &tValue) const
 Generate the maximum value of that type.
 
template<class T >
void GenerateMax (T *pTValue) const
 Generate the maximum value of that type.
 
template<class T >
void GenerateMaxInt32 (T &tValue) const
 Generate maximum signed 32-bit integer value.
 
template<class T >
void GenerateMaxInt32 (T *pTValue) const
 Generate maximum signed 32-bit integer value.
 
template<class T >
void GenerateMaxInt31 (T &tValue) const
 Generate maximum signed 31-bit integer value.
 
template<class T >
void GenerateMaxInt31 (T *pTValue) const
 Generate maximum signed 31-bit integer value.
 
template<class T >
void GenerateInvalid (T &tValue) const
 Generate invalid value.
 
template<class T >
void GenerateInvalid (T *pTValue) const
 Generate invalid value.
 
virtual void OnReceiveBroadcast (const CBroadcastMessage *pMessage)
 Callback function. A function that receives a BroadcastMessage.
 
virtual int64_t GetClassType () const =0
 Returns the Type value of Class. The returned value itself has no meaning, but if it is the same type of class, the same value will be displayed, so comparison is possible.
 
const char * GetClassNameWithNamespace () const
 Returns the class name including the namespace of the actual instance.
 
const char * GetClassNameWithoutNamespace () const
 Returns the class name that does not include the namespace of the actual instance.
 
virtual uint32_t GetClassHash () const
 Returns the class hash value of the actual instance. For the same class, even if the instance is different, it has the same value.
 
virtual bool IsLicenseAvailable () const
 Returns whether the algorithm can be used with the current license.
 
const CResult ShareSynchronizationObject (const CFLBase *pSrcObject) const
 Share synchronization object of original object.
 
bool IsSharedSynchronizationObject () const
 Is shared synchronization object.
 
virtual void Throw (const CResult &res, const wchar_t *pWcsExtraMessage=nullptr) const
 Raise an exception. Information and error codes of the object that occurred are recorded in the log.
 
virtual void Throw (const std::exception &res, const wchar_t *pWcsExtraMessage) const
 Raise an exception. Information and error codes of the object that occurred are recorded in the log.
 

Static Public Member Functions

static double Sum (const Base::CFLArray< T > &flaData)
 Total sum calculation.
 
static double Sum (const Base::CFLArray< T > *pFlaData)
 Total sum calculation.
 
static double Sum (const T *pArrData, const int64_t i64Count)
 Total sum calculation.
 
static double SqrSum (const Base::CFLArray< T > &flaData)
 Total sum of squares calculation.
 
static double SqrSum (const Base::CFLArray< T > *pFlaData)
 Total sum of squares calculation.
 
static double SqrSum (const T *pArrData, const int64_t i64Count)
 Total sum of squares calculation.
 
static double SqrtSum (const Base::CFLArray< T > &flaData)
 Total sum of square roots calculation.
 
static double SqrtSum (const Base::CFLArray< T > *pFlaData)
 Total sum of square roots calculation.
 
static double SqrtSum (const T *pArrData, const int64_t i64Count)
 Total sum of square roots calculation.
 
static double Min (const Base::CFLArray< T > &flaData)
 Total minimum calculation.
 
static double Min (const Base::CFLArray< T > *pFlaData)
 Total minimum calculation.
 
static double Min (const T *pArrData, const int64_t i64Count)
 Total minimum calculation.
 
static double Max (const Base::CFLArray< T > &flaData)
 Total maximum calculation.
 
static double Max (const Base::CFLArray< T > *pFlaData)
 Total maximum calculation.
 
static double Max (const T *pArrData, const int64_t i64Count)
 Total maximum calculation.
 
static double Mean (const Base::CFLArray< T > &flaData)
 Total mean calculation.
 
static double Mean (const Base::CFLArray< T > *pFlaData)
 Total mean calculation.
 
static double Mean (const T *pArrData, const int64_t i64Count)
 Total mean calculation.
 
static double Median (const Base::CFLArray< T > &flaData)
 Total median calculation.
 
static double Median (const Base::CFLArray< T > *pFlaData)
 Total median calculation.
 
static double Median (const T *pArrData, const int64_t i64Count)
 Total median calculation.
 
static double VarianceSample (const Base::CFLArray< T > &flaData)
 Calculation of sample variance.
 
static double VarianceSample (const Base::CFLArray< T > *pFlaData)
 Calculation of sample variance.
 
static double VarianceSample (const T *pArrData, const int64_t i64Count)
 Calculation of sample variance.
 
static double VariancePopulation (const Base::CFLArray< T > &flaData)
 Population variance calculation.
 
static double VariancePopulation (const Base::CFLArray< T > *pFlaData)
 Population variance calculation.
 
static double VariancePopulation (const T *pArrData, const int64_t i64Count)
 Population variance calculation.
 
static double StdevSample (const Base::CFLArray< T > &flaData)
 Calculate sample group standard deviation.
 
static double StdevSample (const Base::CFLArray< T > *pFlaData)
 Calculate sample group standard deviation.
 
static double StdevSample (const T *pArrData, const int64_t i64Count)
 Calculate sample group standard deviation.
 
static double StdevPopulation (const Base::CFLArray< T > &flaData)
 Calculate population standard deviation.
 
static double StdevPopulation (const Base::CFLArray< T > *pFlaData)
 Calculate population standard deviation.
 
static double StdevPopulation (const T *pArrData, const int64_t i64Count)
 Calculate population standard deviation.
 
static double CovarianceSample (const Base::CFLArray< T > &flaData1, const Base::CFLArray< T > &flaData2)
 Calculate sample covariance.
 
static double CovarianceSample (const Base::CFLArray< T > *pFlaData1, const Base::CFLArray< T > *pFlaData2)
 Calculate sample covariance.
 
static double CovarianceSample (const T *pArrData1, const int64_t i64Count1, const T *pArrData2, const int64_t i64Count2)
 Calculate sample covariance.
 
static double CovariancePopulation (const Base::CFLArray< T > &flaData1, const Base::CFLArray< T > &flaData2)
 Population covariance calculation.
 
static double CovariancePopulation (const Base::CFLArray< T > *pFlaData1, const Base::CFLArray< T > *pFlaData2)
 Population covariance calculation.
 
static double CovariancePopulation (const T *pArrData1, const int64_t i64Count1, const T *pArrData2, const int64_t i64Count2)
 Population covariance calculation.
 
static double CorrelationCoefficient (const Base::CFLArray< T > &flaData, const Base::CFLArray< T > &flaData2)
 Correlation coefficient calculation.
 
static double CorrelationCoefficient (const Base::CFLArray< T > *pFlaData, const Base::CFLArray< T > *pFlaData2)
 Correlation coefficient calculation.
 
static double CorrelationCoefficient (const T *pArrData1, const int64_t i64Count1, const T *pArrData2, const int64_t i64Count2)
 Correlation coefficient calculation.
 

Detailed Description

template<typename T>
class FLImaging::Foundation::CStatistics< T >

A class that computes statistics based on the values of elements in CFLArray. Support types.

  • int8_t, uint8_t, int16_t, uint16_t, int32_t, uint32_t, int64_t, uint64_t, float, double

Constructor & Destructor Documentation

◆ ~CStatistics()

template<typename T >
virtual FLImaging::Foundation::CStatistics< T >::~CStatistics ( )
virtual

Destructor

Member Function Documentation

◆ CorrelationCoefficient() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CorrelationCoefficient ( const Base::CFLArray< T > & flaData,
const Base::CFLArray< T > & flaData2 )
static

Correlation coefficient calculation.

Parameters
[in]flaDataData source reference to calculate
[in]flaData2Target Constant Reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ CorrelationCoefficient() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CorrelationCoefficient ( const Base::CFLArray< T > * pFlaData,
const Base::CFLArray< T > * pFlaData2 )
static

Correlation coefficient calculation.

Parameters
[in]pFlaDataData source pointer to calculate
[in]pFlaData2Target Constant Reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ CorrelationCoefficient() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CorrelationCoefficient ( const T * pArrData1,
const int64_t i64Count1,
const T * pArrData2,
const int64_t i64Count2 )
static

Correlation coefficient calculation.

Parameters
[in]pArrData1Data source pointer to calculate 1
[in]i64Count1Data count 1
[in]pArrData2Data source pointer to calculate 2
[in]i64Count2Data count 2
Return values
doubleReturn the result of a calculation

◆ CovariancePopulation() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CovariancePopulation ( const Base::CFLArray< T > & flaData1,
const Base::CFLArray< T > & flaData2 )
static

Population covariance calculation.

Parameters
[in]flaData1Target Constant Reference to calculate
[in]flaData2Target Constant Reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ CovariancePopulation() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CovariancePopulation ( const Base::CFLArray< T > * pFlaData1,
const Base::CFLArray< T > * pFlaData2 )
static

Population covariance calculation.

Parameters
[in]pFlaData1Target Constant Reference to calculate
[in]pFlaData2Target Constant Reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ CovariancePopulation() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CovariancePopulation ( const T * pArrData1,
const int64_t i64Count1,
const T * pArrData2,
const int64_t i64Count2 )
static

Population covariance calculation.

Parameters
[in]pArrData1Data source pointer to calculate 1
[in]i64Count1Data count 1
[in]pArrData2Data source pointer to calculate 2
[in]i64Count2Data count 2
Return values
doubleReturn the result of a calculation

◆ CovarianceSample() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CovarianceSample ( const Base::CFLArray< T > & flaData1,
const Base::CFLArray< T > & flaData2 )
static

Calculate sample covariance.

Parameters
[in]flaData1Target Constant Reference to calculate
[in]flaData2Target Constant Reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ CovarianceSample() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CovarianceSample ( const Base::CFLArray< T > * pFlaData1,
const Base::CFLArray< T > * pFlaData2 )
static

Calculate sample covariance.

Parameters
[in]pFlaData1Target Constant Reference to calculate
[in]pFlaData2Target Constant Reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ CovarianceSample() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::CovarianceSample ( const T * pArrData1,
const int64_t i64Count1,
const T * pArrData2,
const int64_t i64Count2 )
static

Calculate sample covariance.

Parameters
[in]pArrData1Data source pointer to calculate 1
[in]i64Count1Data count 1
[in]pArrData2Data source pointer to calculate 2
[in]i64Count2Data count 2
Return values
doubleReturn the result of a calculation

◆ Max() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Max ( const Base::CFLArray< T > & flaData)
static

Total maximum calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Max() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Max ( const Base::CFLArray< T > * pFlaData)
static

Total maximum calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Max() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Max ( const T * pArrData,
const int64_t i64Count )
static

Total maximum calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ Mean() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Mean ( const Base::CFLArray< T > & flaData)
static

Total mean calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Mean() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Mean ( const Base::CFLArray< T > * pFlaData)
static

Total mean calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Mean() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Mean ( const T * pArrData,
const int64_t i64Count )
static

Total mean calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ Median() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Median ( const Base::CFLArray< T > & flaData)
static

Total median calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Median() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Median ( const Base::CFLArray< T > * pFlaData)
static

Total median calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Median() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Median ( const T * pArrData,
const int64_t i64Count )
static

Total median calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ Min() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Min ( const Base::CFLArray< T > & flaData)
static

Total minimum calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Min() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Min ( const Base::CFLArray< T > * pFlaData)
static

Total minimum calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Min() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Min ( const T * pArrData,
const int64_t i64Count )
static

Total minimum calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ SqrSum() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::SqrSum ( const Base::CFLArray< T > & flaData)
static

Total sum of squares calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ SqrSum() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::SqrSum ( const Base::CFLArray< T > * pFlaData)
static

Total sum of squares calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ SqrSum() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::SqrSum ( const T * pArrData,
const int64_t i64Count )
static

Total sum of squares calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ SqrtSum() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::SqrtSum ( const Base::CFLArray< T > & flaData)
static

Total sum of square roots calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ SqrtSum() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::SqrtSum ( const Base::CFLArray< T > * pFlaData)
static

Total sum of square roots calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ SqrtSum() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::SqrtSum ( const T * pArrData,
const int64_t i64Count )
static

Total sum of square roots calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ StdevPopulation() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::StdevPopulation ( const Base::CFLArray< T > & flaData)
static

Calculate population standard deviation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ StdevPopulation() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::StdevPopulation ( const Base::CFLArray< T > * pFlaData)
static

Calculate population standard deviation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ StdevPopulation() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::StdevPopulation ( const T * pArrData,
const int64_t i64Count )
static

Calculate population standard deviation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ StdevSample() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::StdevSample ( const Base::CFLArray< T > & flaData)
static

Calculate sample group standard deviation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ StdevSample() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::StdevSample ( const Base::CFLArray< T > * pFlaData)
static

Calculate sample group standard deviation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ StdevSample() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::StdevSample ( const T * pArrData,
const int64_t i64Count )
static

Calculate sample group standard deviation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ Sum() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Sum ( const Base::CFLArray< T > & flaData)
static

Total sum calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Sum() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Sum ( const Base::CFLArray< T > * pFlaData)
static

Total sum calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ Sum() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::Sum ( const T * pArrData,
const int64_t i64Count )
static

Total sum calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ VariancePopulation() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::VariancePopulation ( const Base::CFLArray< T > & flaData)
static

Population variance calculation.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ VariancePopulation() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::VariancePopulation ( const Base::CFLArray< T > * pFlaData)
static

Population variance calculation.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ VariancePopulation() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::VariancePopulation ( const T * pArrData,
const int64_t i64Count )
static

Population variance calculation.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation

◆ VarianceSample() [1/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::VarianceSample ( const Base::CFLArray< T > & flaData)
static

Calculation of sample variance.

Parameters
[in]flaDataData source reference to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ VarianceSample() [2/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::VarianceSample ( const Base::CFLArray< T > * pFlaData)
static

Calculation of sample variance.

Parameters
[in]pFlaDataData source pointer to calculate
Return values
doubleReturn the result of a calculation
See also
FLImaging::Base::CFLArray

◆ VarianceSample() [3/3]

template<typename T >
static double FLImaging::Foundation::CStatistics< T >::VarianceSample ( const T * pArrData,
const int64_t i64Count )
static

Calculation of sample variance.

Parameters
[in]pArrDataData source pointer to calculate
[in]i64CountData count
Return values
doubleReturn the result of a calculation