Functions
SQBatchLevelModel.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQModel.h"
#include "SQPrepareBatchPrediction.h"

Go to the source code of this file.

Functions

SQ_ErrorCode SQ_IsBatchLevelModel (SQ_Model pModel, SQ_Bool *bIsBLM)
 
SQ_ErrorCode SQ_GetBatchVIP (SQ_Model pModel, int iComponent, int iYTerm, int iPhase, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetPrepareBatchPrediction (SQ_Model pModel, SQ_PrepareBatchPrediction *pPreparePrediction)
 
SQ_ErrorCode SQ_GetPhasesForBatchPrediction (SQ_Model pModel, SQ_StringVector *pPhasesForBatchPredict)
 

Function Documentation

◆ SQ_GetBatchVIP()

SQ_ErrorCode SQ_GetBatchVIP ( SQ_Model  pModel,
int  iComponent,
int  iYTerm,
int  iPhase,
SQ_VectorData pVectorData 
)

The importance of a variable during the batch evolution and for the quality of the completed batch. Batch VIP is computed for every phase. For a PLS model at the batch level, it is computed for the selected Y.

Parameters
[in]pModelThe batch level model to use.
[in]iComponentThe component the batch VIP should be calculated for.
[in]iYTermThe Y term the batch VIP should be calculated for.
[in]iPhaseThe phase the batch VIP should be calculated for.
[out]pVectorDataA pointer to the BatchVIP results. Number of rows in matrix = 2 Number of columns in matrix =
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetPhasesForBatchPrediction()

SQ_ErrorCode SQ_GetPhasesForBatchPrediction ( SQ_Model  pModel,
SQ_StringVector pPhasesForBatchPredict 
)

Retrieves the phases that are needed to perform a prediction on this batch level model.

Parameters
[in]pModelThe batch level model to use.
[out]pPhasesForBatchPredictThe phase names. The vector must be cleared with SQ_ClearStringVector.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetPrepareBatchPrediction()

SQ_ErrorCode SQ_GetPrepareBatchPrediction ( SQ_Model  pModel,
SQ_PrepareBatchPrediction pPreparePrediction 
)

Retrieves the PrepareBatchPrediction object that should be used to set data for a batch prediction. The returned object must be released by SQ_ClearPrepareBatchPrediction.

Parameters
[in]pModelThe batch level model to perform a prediction on.
[out]pPreparePredictionThe PreparePrediction object that should be used to set data for a prediction.
Must be released by SQ_ClearPrepareBatchPrediction.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_IsBatchLevelModel()

SQ_ErrorCode SQ_IsBatchLevelModel ( SQ_Model  pModel,
SQ_Bool bIsBLM 
)

An inquiry whether the model is a Batch Level Model.

Parameters
[in]pModelThe model to use.
[out]bIsBLMIs set to SQ_True if the model is a BLM.
Returns
Returns SQ_E_OK if success or an error code

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