SQBatchEvolutionPrediction.h
Go to the documentation of this file.
1 /*
2 Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
3 */
4 #ifndef _SQBATCHEVOLUTIONPREDICTION_H_
5 #define _SQBATCHEVOLUTIONPREDICTION_H_
6 
7 #include "SQDef.h"
8 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #ifdef _WIN32
18 #pragma pack(push, 8)
19 #endif
20 
21 #include "SQErrorCodes.h"
22 #include "SQCommon.h"
23 #include "SQPrediction.h"
24 #include "SQIntVector.h"
25 #include "SQVectorData.h"
26 
49  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsDModXPS(SQ_Prediction pPrediction, float fMaturity, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData);
72  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsDModXGroupPS(SQ_Prediction pPrediction, SQ_FloatVector* pMaturity, SQ_IntVector* pPhaseIteration, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData);
73 
89  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsDModYPS(SQ_Prediction pPrediction, float fMaturity, SQ_WeightType eWeightType, int iComponent, SQ_VectorData *pVectorData);
90 
109  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsDModYGroupPS(SQ_Prediction pPrediction, SQ_FloatVector* pMaturity, SQ_IntVector* pPhaseIteration, SQ_WeightType eWeightType, int iComponent, SQ_VectorData *pVectorData);
110 
133  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsScorePSSingleWeight(SQ_Prediction pPrediction, float fMaturity1, SQ_Bool bAverage, float fMaturity2, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData);
134 
163  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsScorePSSingleWeightGroup(SQ_Prediction pPrediction, SQ_FloatVector* pMaturity1, SQ_IntVector* pPhaseIteration1, SQ_Bool bAverage, SQ_FloatVector* pMaturity2, SQ_IntVector* pPhaseIteration2, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData);
164 
193  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsScorePSMultiWeight(SQ_Prediction pPrediction, float fMaturity1, SQ_Bool bAverage, float fMaturity2, SQ_IntVector* pWeightType, SQ_IntVector* pComponents, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData);
194 
229  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedContributionsScorePSMultiWeightGroup(SQ_Prediction pPrediction, SQ_FloatVector* pMaturity1, SQ_IntVector* pPhaseIteration1, SQ_Bool bAverage, SQ_FloatVector* pMaturity2, SQ_IntVector* pPhaseIteration2, SQ_IntVector* pWeightType, SQ_IntVector* pComponents, SQ_ReconstructState bReconstruct, SQ_VectorData* pVectorData);
230 
248  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedDModXPS(SQ_Prediction pPrediction, int iComponent, SQ_NormalizedState bNormalized, SQ_ModelingPowerWeightedState bModelingPowerWeighted, SQ_VectorData *pVectorData);
249 
265  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedTPS(SQ_Prediction pPrediction, int iComponent, SQ_VectorData *pVectorData);
266 
282  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedToPS(SQ_Prediction pPrediction, int iComponent, SQ_VectorData *pVectorData);
283 
303  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedT2RangePS(SQ_Prediction pPrediction, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData);
304 
316  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedTimeMaturityPS(SQ_Prediction pPrediction, SQ_VectorData *pVectorData);
317 
339  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedXVarPS(SQ_Prediction pPrediction, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iXTerm, SQ_VectorData *pVectorData);
340 
363  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedYPredPS(SQ_Prediction pPrediction, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData);
364 
385  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedYVarPS(SQ_Prediction pPrediction, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData);
386 
387  /*****************************************************************************************
388  *
389  * Out of Control
390  *
391  * The following functions are available for a Batch Evolution model.
392  * These vectors are the Out of Control summary for all of the vectors in the Batch Control charts.
393  *
394  * The Out of Control summary for a given vector, for example scores, t1,
395  * computes for every batch the ratio of the area of the vector outside the sigma limits to the total area inside the limits.
396  * The Out of control summary is then expressed as a percent of the area inside the limits.
397  *
398  * The Out of Control summary for all the vectors, i.e., scores, DModX, T2range and Observed vs predicted,
399  * from both the training set and the prediction set are always computed on aligned vectors.
400  *
401  ******************************************************************************************/
413  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedDModXPSOOCSum(SQ_Prediction pPrediction, int iComponent, float fLimit, SQ_VectorData *pVectorData);
414 
427  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedTPSOOCSum(SQ_Prediction pPrediction, int iComponent, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData);
428 
442  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedT2RangePSOOCSum(SQ_Prediction pPrediction, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData);
443 
465  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedXVarPSOOCSum(SQ_Prediction pPrediction, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iColumnXIndex, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData);
466 
488  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAlignedYPredPSOOCSum(SQ_Prediction pPrediction, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData);
489 
492 #ifdef _WIN32
493 #pragma pack(pop)
494 #endif
495 
496 #ifdef __cplusplus
497 }
498 #endif /*__cplusplus*/
499 
500 #endif /* _SQBATCHEVOLUTIONPREDICTION_H_ */
tagSQ_FloatVector
Definition: SQFloatVector.h:27
SQ_ReconstructState
enum SQ_TriStateReconstructState SQ_ReconstructState
SQ_GetAlignedContributionsScorePSMultiWeight
SQ_ErrorCode SQ_GetAlignedContributionsScorePSMultiWeight(SQ_Prediction pPrediction, float fMaturity1, SQ_Bool bAverage, float fMaturity2, SQ_IntVector *pWeightType, SQ_IntVector *pComponents, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
SQ_Bool
enum SQ_BoolEnum SQ_Bool
SQ_GetAlignedTPS
SQ_ErrorCode SQ_GetAlignedTPS(SQ_Prediction pPrediction, int iComponent, SQ_VectorData *pVectorData)
SQ_GetAlignedXVarPSOOCSum
SQ_ErrorCode SQ_GetAlignedXVarPSOOCSum(SQ_Prediction pPrediction, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iColumnXIndex, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData)
SQCommon.h
SQ_GetAlignedContributionsDModYGroupPS
SQ_ErrorCode SQ_GetAlignedContributionsDModYGroupPS(SQ_Prediction pPrediction, SQ_FloatVector *pMaturity, SQ_IntVector *pPhaseIteration, SQ_WeightType eWeightType, int iComponent, SQ_VectorData *pVectorData)
SQVectorData.h
SQ_GetAlignedTPSOOCSum
SQ_ErrorCode SQ_GetAlignedTPSOOCSum(SQ_Prediction pPrediction, int iComponent, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData)
SQ_BacktransformedState
enum SQ_TriStateBacktransformedState SQ_BacktransformedState
SQ_WeightType
enum SQ_WeightTypeEnum SQ_WeightType
SQPrediction.h
SQ_GetAlignedTimeMaturityPS
SQ_ErrorCode SQ_GetAlignedTimeMaturityPS(SQ_Prediction pPrediction, SQ_VectorData *pVectorData)
SQ_GetAlignedContributionsDModXPS
SQ_ErrorCode SQ_GetAlignedContributionsDModXPS(SQ_Prediction pPrediction, float fMaturity, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
tagSQ_IntVector
Definition: SQIntVector.h:27
SQIntVector.h
SQ_GetAlignedContributionsScorePSSingleWeightGroup
SQ_ErrorCode SQ_GetAlignedContributionsScorePSSingleWeightGroup(SQ_Prediction pPrediction, SQ_FloatVector *pMaturity1, SQ_IntVector *pPhaseIteration1, SQ_Bool bAverage, SQ_FloatVector *pMaturity2, SQ_IntVector *pPhaseIteration2, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
SQ_GetAlignedContributionsScorePSSingleWeight
SQ_ErrorCode SQ_GetAlignedContributionsScorePSSingleWeight(SQ_Prediction pPrediction, float fMaturity1, SQ_Bool bAverage, float fMaturity2, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
SQ_GetAlignedToPS
SQ_ErrorCode SQ_GetAlignedToPS(SQ_Prediction pPrediction, int iComponent, SQ_VectorData *pVectorData)
SQ_GetAlignedContributionsDModXGroupPS
SQ_ErrorCode SQ_GetAlignedContributionsDModXGroupPS(SQ_Prediction pPrediction, SQ_FloatVector *pMaturity, SQ_IntVector *pPhaseIteration, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
SQ_GetAlignedYVarPS
SQ_ErrorCode SQ_GetAlignedYVarPS(SQ_Prediction pPrediction, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData)
SQ_GetAlignedT2RangePS
SQ_ErrorCode SQ_GetAlignedT2RangePS(SQ_Prediction pPrediction, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData)
SQ_GetAlignedT2RangePSOOCSum
SQ_ErrorCode SQ_GetAlignedT2RangePSOOCSum(SQ_Prediction pPrediction, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData)
SQ_GetAlignedContributionsScorePSMultiWeightGroup
SQ_ErrorCode SQ_GetAlignedContributionsScorePSMultiWeightGroup(SQ_Prediction pPrediction, SQ_FloatVector *pMaturity1, SQ_IntVector *pPhaseIteration1, SQ_Bool bAverage, SQ_FloatVector *pMaturity2, SQ_IntVector *pPhaseIteration2, SQ_IntVector *pWeightType, SQ_IntVector *pComponents, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
SQ_ErrorCode
enum SQ_ErrorCodeEnum SQ_ErrorCode
SQ_GetAlignedYPredPSOOCSum
SQ_ErrorCode SQ_GetAlignedYPredPSOOCSum(SQ_Prediction pPrediction, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData)
SQ_GetAlignedXVarPS
SQ_ErrorCode SQ_GetAlignedXVarPS(SQ_Prediction pPrediction, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iXTerm, SQ_VectorData *pVectorData)
SQ_ModelingPowerWeightedState
enum SQ_TriStateModelingPowerWeightedState SQ_ModelingPowerWeightedState
tagSQ_Prediction
Definition: SQPrediction.h:30
SQ_GetAlignedYPredPS
SQ_ErrorCode SQ_GetAlignedYPredPS(SQ_Prediction pPrediction, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData)
SQErrorCodes.h
SQ_GetAlignedContributionsDModYPS
SQ_ErrorCode SQ_GetAlignedContributionsDModYPS(SQ_Prediction pPrediction, float fMaturity, SQ_WeightType eWeightType, int iComponent, SQ_VectorData *pVectorData)
SQ_GetAlignedDModXPSOOCSum
SQ_ErrorCode SQ_GetAlignedDModXPSOOCSum(SQ_Prediction pPrediction, int iComponent, float fLimit, SQ_VectorData *pVectorData)
tagSQ_VectorData
Definition: SQVectorData.h:29
SQ_NormalizedState
enum SQ_TriStateNormalizedState SQ_NormalizedState
SQ_GetAlignedDModXPS
SQ_ErrorCode SQ_GetAlignedDModXPS(SQ_Prediction pPrediction, int iComponent, SQ_NormalizedState bNormalized, SQ_ModelingPowerWeightedState bModelingPowerWeighted, SQ_VectorData *pVectorData)
SQ_UnscaledState
enum SQ_TriStateUnscaledState SQ_UnscaledState

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