Classes | Typedefs | Functions
SQModelStatistics.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQIntVector.h"
#include "SQFloatVector.h"

Go to the source code of this file.

Classes

struct  tagSQ_ModelStatistics
 

Typedefs

typedef struct tagSQ_ModelStatisticsSQ_ModelStatistics
 

Functions

SQ_ErrorCode SQ_ClearModelStatistics (SQ_ModelStatistics *pStatistics)
 
SQ_ErrorCode SQ_GetObservationsFromStatistics (SQ_ModelStatistics pStatistics, SQ_IntVector *pObservations)
 
SQ_ErrorCode SQ_GetMissingFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pMisVals)
 
SQ_ErrorCode SQ_GetMinFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pMin)
 
SQ_ErrorCode SQ_GetMaxFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pMax)
 
SQ_ErrorCode SQ_GetMinMaxFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pMinMax)
 
SQ_ErrorCode SQ_GetMeanFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pMean)
 
SQ_ErrorCode SQ_GetMedianFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pMedian)
 
SQ_ErrorCode SQ_GetStdDevFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pStdDev)
 
SQ_ErrorCode SQ_GetStdDevMeanFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pStdDevMean)
 
SQ_ErrorCode SQ_GetSkewnessFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pSkewness)
 
SQ_ErrorCode SQ_GetSkewnessTestFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pSkewnessTest)
 
SQ_ErrorCode SQ_GetKurtosisFromStatistics (SQ_ModelStatistics pStatistics, SQ_FloatVector *pKurtosis)
 

Detailed Description

This file list the SQModelStatistics object used in Umetrics SIMCA-Q products.

Typedef Documentation

◆ SQ_ModelStatistics

A a handle to data with model statistics information. IMPORTANT: Always initialize it to NULL!

Function Documentation

◆ SQ_ClearModelStatistics()

SQ_ErrorCode SQ_ClearModelStatistics ( SQ_ModelStatistics pStatistics)

Removes the model statistics, this function must be called for every statistics object that has been received from SQ_GetStatistics.

See also
tagSQ_ModelStatistics
Parameters
[in]pStatisticsThe model statistics object to be removed.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetKurtosisFromStatistics()

SQ_ErrorCode SQ_GetKurtosisFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pKurtosis 
)

Retrieves the kurtosis values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pKurtosisKurtosis values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetMaxFromStatistics()

SQ_ErrorCode SQ_GetMaxFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pMax 
)

Retrieves the maximum values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pMaxMaximum values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetMeanFromStatistics()

SQ_ErrorCode SQ_GetMeanFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pMean 
)

Retrieves the mean values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pMeanMean values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetMedianFromStatistics()

SQ_ErrorCode SQ_GetMedianFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pMedian 
)

Retrieves the median values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pMedianMedian values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetMinFromStatistics()

SQ_ErrorCode SQ_GetMinFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pMin 
)

Retrieves the minimum values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pMinMinimum values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetMinMaxFromStatistics()

SQ_ErrorCode SQ_GetMinMaxFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pMinMax 
)

Retrieves the minimum divided by maximum values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pMinMaxMinimum divided by maximum values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetMissingFromStatistics()

SQ_ErrorCode SQ_GetMissingFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pMisVals 
)

Retrieves the number of missing values in percent from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pMisValsNumber of missing values in percent for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetObservationsFromStatistics()

SQ_ErrorCode SQ_GetObservationsFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_IntVector pObservations 
)

Retrieves the number of observations from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pObservationsNumber of observations for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetSkewnessFromStatistics()

SQ_ErrorCode SQ_GetSkewnessFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pSkewness 
)

Retrieves the skewness values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pSkewnessSkewness values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetSkewnessTestFromStatistics()

SQ_ErrorCode SQ_GetSkewnessTestFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pSkewnessTest 
)

Retrieves the skewness test values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pSkewnessTestSkewness test values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetStdDevFromStatistics()

SQ_ErrorCode SQ_GetStdDevFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pStdDev 
)

Retrieves the standard deviation values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pStdDevStandard deviation values for each variable
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetStdDevMeanFromStatistics()

SQ_ErrorCode SQ_GetStdDevMeanFromStatistics ( SQ_ModelStatistics  pStatistics,
SQ_FloatVector pStdDevMean 
)

Retrieves the standard deviation divided by mean values from model statistics

Parameters
[in]pStatisticsThe model statistics object to get information from.
[out]pStdDevMeanStandard deviation divided by mean values for each variable
Returns
Returns SQ_E_OK if success or an error code

Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen