Go to the source code of this file.
Classes | |
struct | tagSQ_ShewhartControlChart |
struct | tagSQ_EWMAControlChart |
struct | tagSQ_CusumControlChart |
Typedefs | |
typedef struct tagSQ_ShewhartControlChart * | SQ_ShewhartControlChart |
typedef struct tagSQ_EWMAControlChart * | SQ_EWMAControlChart |
typedef struct tagSQ_CusumControlChart * | SQ_CusumControlChart |
typedef enum SQ_ShewhartTypeEnum | SQ_ShewhartType |
typedef enum SQ_EWMATypeEnum | SQ_EWMAType |
Enumerations | |
enum | SQ_ShewhartTypeEnum { SQ_SCC_MEANRANGE =0, SQ_SCC_MEANSTDDEV } |
enum | SQ_EWMATypeEnum { SQ_FILTER = 0, SQ_PREDICTIVE } |
This file contains the different control charts that can be created with Umetrics SIMCA-Q products.
typedef struct tagSQ_CusumControlChart * SQ_CusumControlChart |
The handle used to identify a Cusum control chart.
typedef struct tagSQ_EWMAControlChart * SQ_EWMAControlChart |
The handle used to identify a EWMA control chart.
typedef enum SQ_EWMATypeEnum SQ_EWMAType |
An enum defining the different EWMA calculations. Before SIMCA-Q 14.1, only predictive (SQ_PREDICTIVE) was available.
typedef struct tagSQ_ShewhartControlChart * SQ_ShewhartControlChart |
The handle used to identify a Shewhart control chart. IMPORTANT: Always initialize it to NULL!
typedef enum SQ_ShewhartTypeEnum SQ_ShewhartType |
An enum defining the different Shewhart types that can be requested from a Shewhart control chart.
enum SQ_EWMATypeEnum |
enum SQ_ShewhartTypeEnum |
SQ_ErrorCode SQ_ClearCusumControlChart | ( | SQ_CusumControlChart * | pCusum | ) |
Removes the Cusum Control Chart, this function must be called for every Cusum Control Chart object that is created.
[in] | pCusum | The Cusum Control Chart object to be removed. |
SQ_ErrorCode SQ_ClearEWMAControlChart | ( | SQ_EWMAControlChart * | pEWMA | ) |
Removes the EWMA Control Chart, this function must be called for every EWMA Control Chart object that is created.
[in] | pEWMA | The EWMA Control Chart object to be removed. |
SQ_ErrorCode SQ_ClearShewhartControlChart | ( | SQ_ShewhartControlChart * | pShewhartControlChart | ) |
Removes the Shewhart Control Chart, this function must be called for every Shewhart Control Chart object that is created.
[in] | pShewhartControlChart | The Shewhart Control Chart object to be removed. |
SQ_ErrorCode SQ_GetCusumActionLimit | ( | SQ_CusumControlChart | pCusumControlChart, |
float * | pActionLimit | ||
) |
Get the action limit from the CUSUM control chart. 4.5 standard deviation, using S(Mxx) when sample size = 1 and SAvg when sample size > 1.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pActionLimit | The action limit. |
SQ_ErrorCode SQ_GetCusumControlChart | ( | SQ_Project | pProject, |
SQ_FloatVector | pData, | ||
int | iSampleSize, | ||
float | fTarget, | ||
float | fStdDev, | ||
SQ_CusumControlChart * | pCusum | ||
) |
Get the CUSUM control chart. Control Charts are available for any project, except for an observation level batch project.
[in] | pProject | The project to use |
[in] | pData | The data to get the CUSUM control chart from. |
[in] | iSampleSize | Must be smaller than or equal to half of the number of observations (the size of pData divided in two) and between 1 to 25. |
[in] | fTarget | Set to MissingValue if target will be estimated. |
[in] | fStdDev | Set to MissingValue if stddev will be estimated. |
[out] | pCusum | A pointer to the CUSUM results. |
SQ_ErrorCode SQ_GetCusumDeadBand | ( | SQ_CusumControlChart | pCusumControlChart, |
float * | pDeadBand | ||
) |
Get the dead band from the CUSUM control chart. Dead Band (K) (or allowable slack) = standard deviation/2, using S(Mxx) when sample size = 1 and SAvg when sample size > 1.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pDeadBand | The dead band. |
SQ_ErrorCode SQ_GetCusumDevFromTarget | ( | SQ_CusumControlChart | pCusumControlChart, |
SQ_FloatVector * | pDevFromTarget | ||
) |
Get the DevFromTarget vector from the CUSUM control chart. Deviation from target = average of subgroup – target.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pDevFromTarget | The EWMA of samples of the selected item. |
SQ_ErrorCode SQ_GetCusumHigh | ( | SQ_CusumControlChart | pCusumControlChart, |
SQ_FloatVector * | pHighCuSum | ||
) |
Get the high CUSUM vector from the CUSUM control chart. Cumulative sum on the high side difference used to detect a deviation from the target on the high side. High CUSUM is set to zero when negative.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pHighCuSum | The high CUSUM. |
SQ_ErrorCode SQ_GetCusumLow | ( | SQ_CusumControlChart | pCusumControlChart, |
SQ_FloatVector * | pLowCuSum | ||
) |
Get the low CUSUM vector from the CUSUM control chart. Cumulative sum on the low side difference used to detect a deviation from the target on the low side. Low CUSUM is set to zero when negative.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pLowCuSum | The low CUSUM. |
SQ_ErrorCode SQ_GetCusumRangeControlChart | ( | SQ_Project | pProject, |
SQ_FloatVector | pData, | ||
SQ_FloatVector | pRangeData, | ||
float | fRange, | ||
float | fTarget, | ||
float | fStdDev, | ||
SQ_CusumControlChart * | pCusum | ||
) |
Get the CUSUM control chart using a range variable. Control Charts are available for any project, except for an observation level batch project.
[in] | pProject | The project to use |
[in] | pData | The data to get the CUSUM control chart from. |
[in] | pRangeData | The vector to create the grouping from. Should be of equal length as pData |
[in] | fRange | A range in the range data vector |
[in] | fTarget | Set to MissingValue if target will be estimated. |
[in] | fStdDev | Set to MissingValue if stddev will be estimated. |
[out] | pCusum | A pointer to the CUSUM results. |
SQ_ErrorCode SQ_GetCusumStdDevIndividual | ( | SQ_CusumControlChart | pCusumControlChart, |
float * | pStdDev | ||
) |
Get the StdDev individual from the CUSUM control chart. Process standard deviation over all observations. S(MModel number) in SIMCA.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pStdDev | The StdDev individual. |
SQ_ErrorCode SQ_GetCusumStdDevProcess | ( | SQ_CusumControlChart | pCusumControlChart, |
float * | pStdDev | ||
) |
Get the StdDev process from the CUSUM control chart. If not User Entered, estimated from Avg. S(RAvg) or S(SAvg) in SIMCA.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pStdDev | The StdDev process. |
SQ_ErrorCode SQ_GetCusumTarget | ( | SQ_CusumControlChart | pCusumControlChart, |
float * | pTarget | ||
) |
Get the target from the CUSUM control chart. If not User Entered, estimated as the grand average of the selected item over the training set. Target(MModel number) in SIMCA.
[in] | pCusumControlChart | The CUSUM control chart. |
[out] | pTarget | The target. |
SQ_ErrorCode SQ_GetEWMAControlChart | ( | SQ_Project | pProject, |
SQ_FloatVector | pData, | ||
int | iSampleSize, | ||
float | fLambda, | ||
float | fTarget, | ||
float | fStdDev, | ||
SQ_EWMAType | eEWMAType, | ||
SQ_EWMAControlChart * | pEWMA | ||
) |
Get the EWMA(Exponentially weighted moving averages) control chart. For a detailed description of the nomenclature, see "McNeese: Statistical methods for the process industries" Quality and Reliability p.28 Control Charts are available for any project, except for an observation level batch project.
[in] | pProject | The project to use |
[in] | pData | The data to get the EWMA control chart from. |
[in] | iSampleSize | Must be smaller than the number of observations (the size of pData) and between 1 to 25. |
[in] | fLambda | Set to MissingValue if lambda will be estimated. |
[in] | fTarget | Set to MissingValue if target will be estimated. |
[in] | fStdDev | Set to MissingValue if stddev will be estimated. |
[in] | eEWMAType | The type of EWMA calculation filter or predictive, before SIMCA-Q 14.1 only predictive was available. |
[out] | pEWMA | A pointer to the EWMA struct. |
SQ_ErrorCode SQ_GetEWMALambda | ( | SQ_EWMAControlChart | pEWMAControlChart, |
float * | pfLambda | ||
) |
Get the EWMA lambda from the EWMA control chart. If not User Entered, estimated from the training set, which minimizes the error sum of squares.
[in] | pEWMAControlChart | The EWMA control chart. |
[out] | pfLambda | The lambda. |
SQ_ErrorCode SQ_GetEWMARangeControlChart | ( | SQ_Project | pProject, |
SQ_FloatVector | pData, | ||
SQ_FloatVector | pRangeData, | ||
float | fRange, | ||
float | fLambda, | ||
float | fTarget, | ||
float | fStdDev, | ||
SQ_EWMAType | eEWMAType, | ||
SQ_EWMAControlChart * | pEWMA | ||
) |
Get the EWMA(Exponentially weighted moving averages) control chart using a range variable For a detailed description of the nomenclature, see "McNeese: Statistical methods for the process industries" Quality and Reliability p.28 Control Charts are available for any project, except for an observation level batch project.
[in] | pProject | The project to use |
[in] | pData | The data to get the EWMA control chart from. |
[in] | pRangeData | The vector to create the grouping from. Should be of equal length as pData |
[in] | fRange | A range in the range data vector |
[in] | fLambda | Set to MissingValue if lambda will be estimated. |
[in] | fTarget | Set to MissingValue if target will be estimated. |
[in] | fStdDev | Set to MissingValue if stddev will be estimated. |
[in] | eEWMAType | The type of EWMA calculation filter or predictive, before SIMCA-Q 14.1 only predictive was available. |
[out] | pEWMA | A pointer to the EWMA struct. |
SQ_ErrorCode SQ_GetEWMAStdDev | ( | SQ_EWMAControlChart | pEWMAControlChart, |
float * | pfStdDev | ||
) |
Get the EWMA StdDev from the EWMA control chart. MSSD, Mean Square Successive Difference = SAvg * (l/(2-l))1/2. S(EWMA) in SIMCA.
[in] | pEWMAControlChart | The EWMA control chart. |
[out] | pfStdDev | The EWMA StdDev. |
SQ_ErrorCode SQ_GetEWMAStdDevIndividual | ( | SQ_EWMAControlChart | pEWMAControlChart, |
float * | pfStdDev | ||
) |
Get the EWMA StdDev individual from the EWMA control chart. Process standard deviation over all observations. S(MModel number) in SIMCA.
[in] | pEWMAControlChart | The EWMA control chart. |
[out] | pfStdDev | The StdDev individual. |
SQ_ErrorCode SQ_GetEWMAStdDevProcess | ( | SQ_EWMAControlChart | pEWMAControlChart, |
float * | pfStdDev | ||
) |
Get the StdDev Process from the EWMA control chart. If not User Entered, estimated from Avg. S(RAvg) or S(SAvg) in SIMCA.
[in] | pEWMAControlChart | The EWMA control chart. |
[out] | pfStdDev | The StdDev Process. |
SQ_ErrorCode SQ_GetEWMAVector | ( | SQ_EWMAControlChart | pEWMAControlChart, |
SQ_FloatVector * | pEWMAVector, | ||
float * | pfTarget, | ||
float * | pfUCL, | ||
float * | pfLCL | ||
) |
Get the EWMA vector and limits from the EWMA control chart.
[in] | pEWMAControlChart | The EWMA control chart. |
[out] | pEWMAVector | The EWMA of samples of the selected item. |
[out] | pfTarget | If not User Entered, estimated as the grand average of the selected item over the training set. Target(MModel number) in SIMCA. |
[out] | pfUCL | Target + 3 * S(EWMA). UCL(EWMA) in SIMCA. |
[out] | pfLCL | Target – 3 * S(EWMA). LCL(EWMA) in SIMCA. |
SQ_ErrorCode SQ_GetSCCEstimatedStdDev | ( | SQ_ShewhartControlChart | pShewhartControlChart, |
float * | pfStdDev, | ||
float * | pfStdDevProcess | ||
) |
Get the Estimated StdDev from the Shewhart control chart.
[in] | pShewhartControlChart | The Shewhart control chart. |
[out] | pfStdDev | The process standard deviation estimated from the Workset. S(MModel number) in SIMCA. |
[out] | pfStdDevProcess | If not User Entered, estimated from Avg. S(RAvg) or S(SAvg) in SIMCA. |
SQ_ErrorCode SQ_GetSCCMean | ( | SQ_ShewhartControlChart | pShewhartControlChart, |
SQ_FloatVector * | pMeanVector, | ||
float * | pfTarget, | ||
float * | pfUCL, | ||
float * | pfLCL | ||
) |
Get the mean from the Shewhart control chart.
[in] | pShewhartControlChart | The Shewhart control chart. |
[out] | pMeanVector | The mean of samples of the selected item. |
[out] | pfTarget | If not User Entered, Overall process average, estimated from average of subgroups. Target(MModel number) in SIMCA. |
[out] | pfUCL | Target + A2Rbar/A3Sbar. UCL(x) in SIMCA. |
[out] | pfLCL | Target - A2Rbar/A3Sbar. LCL(x) in SIMCA. |
SQ_ErrorCode SQ_GetSCCRange | ( | SQ_ShewhartControlChart | pShewhartControlChart, |
SQ_FloatVector * | pRangeVector, | ||
float * | pfMean, | ||
float * | pfUCL, | ||
float * | pfLCL | ||
) |
Get the range from the Shewhart control chart.
[in] | pShewhartControlChart | The Shewhart control chart. |
[out] | pRangeVector | The range of samples of the selected item. |
[out] | pfMean | Average range of subgroups. (Rbar). RAvg(within, MModel number) in SIMCA. |
[out] | pfUCL | D4Rbar. UCL(r) in SIMCA. |
[out] | pfLCL | D3Rbar. LCL(r) in SIMCA. |
SQ_ErrorCode SQ_GetSCCStdDev | ( | SQ_ShewhartControlChart | pShewhartControlChart, |
SQ_FloatVector * | pStdDevVector, | ||
float * | pfMean, | ||
float * | pfUCL, | ||
float * | pfLCL | ||
) |
Get the StdDev from the Shewhart control chart.
[in] | pShewhartControlChart | The Shewhart control chart. |
[out] | pStdDevVector | The standard deviation of samples of the selected item. |
[out] | pfMean | Average standard deviation of the subgroups. (Sbar) SAvg(within, MModel number) in SIMCA. |
[out] | pfUCL | B4Sbar. UCL(s) in SIMCA. |
[out] | pfLCL | B3Sbar. LCL(s) in SIMCA. |
SQ_ErrorCode SQ_GetShewhartControlChart | ( | SQ_Project | pProject, |
SQ_FloatVector | pData, | ||
SQ_ShewhartType | eShewhartType, | ||
int | iSampleSize, | ||
float | fTarget, | ||
float | fStdDev, | ||
SQ_ShewhartControlChart * | pShewhart | ||
) |
Get the Shewhart control chart. For a detailed description of the nomenclature, see "McNeese: Statistical methods for the process industries" Quality and Reliability p.28 A2, A3, B3, B4, D3, D4, A2 and d2 from McNeese Control Charts are available for any project, except for an observation level batch project.
[in] | pProject | The project to use |
[in] | pData | The data to get the Shewhart control chart from. |
[in] | eShewhartType | The type of the Shewhart. |
[in] | iSampleSize | Must be smaller than the number of observations (the size of pData) and between 1 to 25. |
[in] | fTarget | Set to MissingValue if target will be estimated. |
[in] | fStdDev | Set to MissingValue if stddev will be estimated. |
[out] | pShewhart | A pointer to the Shewhart object. |
SQ_ErrorCode SQ_GetShewhartRangeGroupControlChart | ( | SQ_Project | pProject, |
SQ_FloatVector | pData, | ||
SQ_FloatVector | pRangeData, | ||
float | fRange, | ||
SQ_ShewhartType | eShewhartType, | ||
float | fTarget, | ||
float | fStdDev, | ||
SQ_ShewhartControlChart * | pShewhart | ||
) |
Get the Shewhart control chart with a range variable. For a detailed description of the nomenclature, see "McNeese: Statistical methods for the process industries" Quality and Reliability p.28 A2, A3, B3, B4, D3, D4, A2 and d2 from McNeese Control Charts are available for any project, except for an observation level batch project.
[in] | pProject | The project to use |
[in] | pData | The data to get the Shewhart control chart from. |
[in] | pRangeData | The vector to create the grouping from. Should be of equal length as pData |
[in] | fRange | A range in the range data vector |
[in] | eShewhartType | The type of the Shewhart. |
[in] | fTarget | Set to MissingValue if target will be estimated. |
[in] | fStdDev | Set to MissingValue if stddev will be estimated. |
[out] | pShewhart | A pointer to the Shewhart object. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen