Typedefs | Enumerations | Functions
SQBatchEvolutionModel.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQModel.h"

Go to the source code of this file.

Typedefs

typedef enum SQ_LimitEnumType SQ_LimitType
 

Enumerations

enum  SQ_LimitEnumType { SQ_ScoreLimit, SQ_DModXLimit, SQ_T2RangeLimit }
 

Functions

SQ_ErrorCode SQ_IsBatchEvolutionModel (SQ_Model pModel, SQ_Bool *bIsBEM)
 
SQ_ErrorCode SQ_GetModelNumberOfBatches (SQ_Model pModel, int *piNrOfBatches)
 
SQ_ErrorCode SQ_GetModelBatchName (SQ_Model pModel, int iBatchIx, char *szBatchName, int iBufferLength)
 
SQ_ErrorCode SQ_GetPhaseName (SQ_Model pModel, char *szPhaseName, int iBufferLength)
 
SQ_ErrorCode SQ_GetBEMLimits (SQ_Model pModel, SQ_LimitType eLimitType, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsDModX (SQ_Model pModel, float fMaturity, int iBatchIx, const char *szPhaseIteration, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsDModXGroup (SQ_Model pModel, SQ_FloatVector *pMaturity, SQ_IntVector *pBatchIx, SQ_StringVector *pPhaseIterations, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsDModY (SQ_Model pModel, float fMaturity, int iBatchIx, const char *szPhaseIteration, SQ_WeightType eWeightType, int iComponent, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsDModYGroup (SQ_Model pModel, SQ_FloatVector *pMaturity, SQ_IntVector *pBatchIx, SQ_StringVector *pPhaseIterations, SQ_WeightType eWeightType, int iComponent, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsScoreSingleWeight (SQ_Model pModel, float fMaturity1, int iBatchIx1, const char *szPhaseIteration1, float fMaturity2, int iBatchIx2, const char *szPhaseIteration2, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsScoreSingleWeightGroup (SQ_Model pModel, SQ_FloatVector *pMaturity1, SQ_IntVector *pBatchIx1, SQ_StringVector *pPhaseIterations1, SQ_FloatVector *pMaturity2, SQ_IntVector *pBatchIx2, SQ_StringVector *pPhaseIterations2, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsScoreSingleWeightGroupCombined (SQ_Model pModel, SQ_FloatVector *pMaturity, SQ_IntVector *pBatchIx, SQ_StringVector *pPhaseIterations, SQ_WeightType eWeightType, int iComponent, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsScoreMultiWeight (SQ_Model pModel, float fMaturity1, int iBatchIx1, const char *szPhaseIteration1, float fMaturity2, int iBatchIx2, const char *szPhaseIteration2, SQ_IntVector *pWeightType, SQ_IntVector *pComponents, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedContributionsScoreMultiWeightGroup (SQ_Model pModel, SQ_FloatVector *pMaturity1, SQ_IntVector *pBatchIx1, SQ_StringVector *pPhaseIterations1, SQ_FloatVector *pMaturity2, SQ_IntVector *pBatchIx2, SQ_StringVector *pPhaseIterations2, SQ_IntVector *pWeightType, SQ_IntVector *pComponents, SQ_ReconstructState bReconstruct, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedDModX (SQ_Model pModel, int iComponent, SQ_NormalizedState bNormalized, SQ_ModelingPowerWeightedState bModelingPowerWeighted, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedDModXAverageBatch (SQ_Model pModel, int iComponent, SQ_NormalizedState bNormalized, SQ_ModelingPowerWeightedState bModelingPowerWeighted, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedDModXStdDevBatch (SQ_Model pModel, int iComponent, SQ_NormalizedState bNormalized, SQ_ModelingPowerWeightedState bModelingPowerWeighted, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedT (SQ_Model pModel, int iComponent, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedTAverageBatch (SQ_Model pModel, int iComponent, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedTStdDevBatch (SQ_Model pModel, int iComponent, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedTo (SQ_Model pModel, int iComponent, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedToAverageBatch (SQ_Model pModel, int iComponent, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedToStdDevBatch (SQ_Model pModel, int iComponent, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedT2Range (SQ_Model pModel, int iCompFrom, int iCompTo, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedT2RangeAverageBatch (SQ_Model pModel, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedT2RangeStdDevBatch (SQ_Model pModel, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedXVar (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iXTerm, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedXVarAverageBatch (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iXTerm, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedXVarStdDevBatch (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iXTerm, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYVar (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYVarAverageBatch (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYVarStdDevBatch (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedTimeMaturity (SQ_Model pModel, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYPred (SQ_Model pModel, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_IntVector *pBatches, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYPredAverageBatch (SQ_Model pModel, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYPredStdDevBatch (SQ_Model pModel, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedDModXOOCSum (SQ_Model pModel, int iComponent, float fLimit, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedTOOCSum (SQ_Model pModel, int iComponent, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedT2RangeOOCSum (SQ_Model pModel, int iCompFrom, int iCompTo, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedXVarOOCSum (SQ_Model pModel, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, int iColumnXIndex, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData)
 
SQ_ErrorCode SQ_GetAlignedYPredOOCSum (SQ_Model pModel, int iComponent, SQ_UnscaledState bUnscaled, SQ_BacktransformedState bBackTransformed, float fHighLimit, float fLowLimit, SQ_VectorData *pVectorData)
 

Typedef Documentation

◆ SQ_LimitType

An enum defining the different limits in a batch evolution model

Enumeration Type Documentation

◆ SQ_LimitEnumType

An enum defining the different limits in a batch evolution model

Enumerator
SQ_ScoreLimit 

Score limit.

SQ_DModXLimit 

DModX limit.

SQ_T2RangeLimit 

T2Range limit.

Function Documentation

◆ SQ_GetAlignedContributionsDModX()

SQ_ErrorCode SQ_GetAlignedContributionsDModX ( SQ_Model  pModel,
float  fMaturity,
int  iBatchIx,
const char *  szPhaseIteration,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned DModX contribution. Contribution is used to understand how an observation differs from the others in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]fMaturityThe aligned maturity to get the contribution for.
[in]iBatchIxThe batch index to get the contribution for. <1 if the average is to be used.
[in]szPhaseIterationThe name of the phase iteration for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. If iBatchIx <1 it is also ignored and can be NULL.
[in]eWeightTypeThe type of weight. If the model is a PCA model this parameter must be Normalized, RX. If the model is a PLS model this parameter must be Normalized, RX, CoeffCS or VIP.
[in]iComponentThe component of the weight.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the aligned DModX contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsDModXGroup()

SQ_ErrorCode SQ_GetAlignedContributionsDModXGroup ( SQ_Model  pModel,
SQ_FloatVector pMaturity,
SQ_IntVector pBatchIx,
SQ_StringVector pPhaseIterations,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned DModX group contribution. Contribution is used to understand how an observation differs from the others in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]pMaturityA vector with the aligned maturity to get the contribution for.
[in]pBatchIxA vector with the batch index to get the contribution for. <1 if the average is to be used. Must be the same length as the maturity vector.
[in]pPhaseIterationsA vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]eWeightTypeThe type of weight. If the model is a PCA model this parameter must be Normalized, RX. If the model is a PLS model this parameter must be Normalized, RX, CoeffCS or VIP.
[in]iComponentThe component of the weight.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the aligned DModX contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsDModY()

SQ_ErrorCode SQ_GetAlignedContributionsDModY ( SQ_Model  pModel,
float  fMaturity,
int  iBatchIx,
const char *  szPhaseIteration,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_VectorData pVectorData 
)

Aligned DModY contribution. Contribution is used to understand how an observation differs from the others in DModY. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]fMaturityThe aligned maturity to get the contribution for.
[in]iBatchIxThe batch index to get the contribution for. <1 if the average is to be used.
[in]szPhaseIterationThe name of the phase iteration for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. If iBatchIx <1 it is also ignored and can be NULL.
[in]eWeightTypeThe type of weight. Must be Normalized or RY.
[in]iComponentThe component of the weight.
[out]pVectorDataA pointer to the aligned DModY contribution results. Number of rows in matrix = 1. Number of columns in matrix = 1.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsDModYGroup()

SQ_ErrorCode SQ_GetAlignedContributionsDModYGroup ( SQ_Model  pModel,
SQ_FloatVector pMaturity,
SQ_IntVector pBatchIx,
SQ_StringVector pPhaseIterations,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_VectorData pVectorData 
)

Aligned DModY group contribution. Contribution is used to understand how an observation differs from the others in DModY. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]pMaturityA vector with the aligned maturity to get the contribution for.
[in]pBatchIxA vector with the batch index to get the contribution for. <1 if the average is to be used. Must be the same length as the maturity vector.
[in]pPhaseIterationsA vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]eWeightTypeThe type of weight. Must be Normalized or RY.
[in]iComponentThe component of the weight.
[out]pVectorDataA pointer to the aligned DModY contribution results. Number of rows in matrix = 1. Number of columns in matrix = 1.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsScoreMultiWeight()

SQ_ErrorCode SQ_GetAlignedContributionsScoreMultiWeight ( SQ_Model  pModel,
float  fMaturity1,
int  iBatchIx1,
const char *  szPhaseIteration1,
float  fMaturity2,
int  iBatchIx2,
const char *  szPhaseIteration2,
SQ_IntVector pWeightType,
SQ_IntVector pComponents,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned Scores multi weight contribution. Contribution is used to understand how an observation differs from the others in an X score(t) or in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]fMaturity1The aligned maturity for the reference observation (from observation).
[in]iBatchIx1The batch index to get the contribution for. for the reference observation (from observation). <1 if the average is to be used.
[in]szPhaseIteration1The name of the second phase iteration (from observation) for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. If iBatchIx1 <1 it is also ignored and can be NULL.
[in]fMaturity2The aligned maturity for which the contributions are to be calculated (to observation).
[in]iBatchIx2The batch index to get the contribution for. for which the contributions are to be calculated (to observation).
[in]szPhaseIteration2The name of the second phase iteration (to observation) for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. If iBatchIx2 <1 it is also ignored and can be NULL.
[in]pWeightTypeAn int vector containing SQ_WeightType enums. If the model is a PCA model this parameter must be P. If the model is a PLS model this parameter must be P or WStar. If the model is a OPLS model this parameter must be P or PO.
[in]pComponentsA list of component Indices to use. 1 for component 1 in the model, 2 for component 2 and so on. NULL if all components in the model should be used. for OPLS models and PRange weight the component argument is ignored, all components are used, for weight Po the component argument is the orthogonal component number for P_Po, supply 2 components, one predictive component and one orthogonal component.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the aligned Score multi weight contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsScoreMultiWeightGroup()

SQ_ErrorCode SQ_GetAlignedContributionsScoreMultiWeightGroup ( SQ_Model  pModel,
SQ_FloatVector pMaturity1,
SQ_IntVector pBatchIx1,
SQ_StringVector pPhaseIterations1,
SQ_FloatVector pMaturity2,
SQ_IntVector pBatchIx2,
SQ_StringVector pPhaseIterations2,
SQ_IntVector pWeightType,
SQ_IntVector pComponents,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned Scores multi weight contribution. Contribution is used to understand how an observation differs from the others in an X score(t) or in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]pMaturity1A vector with the aligned maturity for the reference observation (from observation).
[in]pBatchIx1A vector with the batch index to get the contribution for. for the reference observation (from observation). Must be the same length as the first maturity vector. <1 if the average is to be used.
[in]pPhaseIterations1A vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]pMaturity2A vector with the aligned maturity for which the contributions are to be calculated (to observation).
[in]pBatchIx2A vector with the batch index to get the contribution for. for which the contributions are to be calculated (to observation). Must be the same length as the second maturity vector.
[in]pPhaseIterations2A vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]pWeightTypeAn int vector containing SQ_WeightType enums. If the model is a PCA model this parameter must be P. If the model is a PLS model this parameter must be P or WStar. If the model is a OPLS model this parameter must be P or PO. For OPLS models and PRange weight the component argument is ignored, all components are used. For weight Po the component argument is the orthogonal component number and the model must be OPLS. For P_Po, supply 2 components, one predictive component and one orthogonal component.
[in]pComponentsA list of component Indices to use. 1 for component 1 in the model, 2 for component 2 and so on. NULL if all components in the model should be used.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the aligned Score multi weight contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsScoreSingleWeight()

SQ_ErrorCode SQ_GetAlignedContributionsScoreSingleWeight ( SQ_Model  pModel,
float  fMaturity1,
int  iBatchIx1,
const char *  szPhaseIteration1,
float  fMaturity2,
int  iBatchIx2,
const char *  szPhaseIteration2,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned Scores single weight contribution. Contribution is used to understand how an observation differs from the others in an X score(t) or in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]fMaturity1The aligned maturity for the reference observation (from observation).
[in]iBatchIx1The batch index to get the contribution for. for the reference observation (from observation). <1 if the average is to be used.
[in]szPhaseIteration1The name of the first phase iteration (from observation) for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. If iBatchIx1 <1 it is also ignored and can be NULL.
[in]fMaturity2The aligned maturity for which the contributions are to be calculated (to observation).
[in]iBatchIx2The batch index to get the contribution for. for which the contributions are to be calculated (to observation).
[in]szPhaseIteration2The name of the second phase iteration (to observation) for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. If iBatchIx2 <1 it is also ignored and can be NULL.
[in]eWeightTypeThe type of weight. If the model is a PCA model this parameter must be Normalized, Raw, RX or P. If the model is a PLS model this parameter can be any weight defined in SQ_WeightType.
[in]iComponentThe component of the weight. Ignored if eWeightType=Normalized or Raw.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the aligned Score single weight contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsScoreSingleWeightGroup()

SQ_ErrorCode SQ_GetAlignedContributionsScoreSingleWeightGroup ( SQ_Model  pModel,
SQ_FloatVector pMaturity1,
SQ_IntVector pBatchIx1,
SQ_StringVector pPhaseIterations1,
SQ_FloatVector pMaturity2,
SQ_IntVector pBatchIx2,
SQ_StringVector pPhaseIterations2,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned Scores single weight group contribution. Contribution is used to understand how an observation differs from the others in an X score(t) or in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]pMaturity1A vector with the aligned maturity for the reference observation (from observation).
[in]pBatchIx1A vector with the batch index to get the contribution for. for the reference observation (from observation). Must be the same length as the first maturity vector. <1 if the average is to be used.
[in]pPhaseIterations1A vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]pMaturity2A vector with the aligned maturity for which the contributions are to be calculated (to observation).
[in]pBatchIx2A vector with the batch index to get the contribution for. for which the contributions are to be calculated (to observation). Must be the same length as the second maturity vector.
[in]pPhaseIterations2A vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]eWeightTypeThe type of weight. If the model is a PCA model this parameter must be Normalized, Raw, RX or P. If the model is a PLS model this parameter can be any weight defined in SQ_WeightType.
[in]iComponentThe component of the weight. Ignored if eWeightType=Normalized or Raw.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the aligned Score single weight contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedContributionsScoreSingleWeightGroupCombined()

SQ_ErrorCode SQ_GetAlignedContributionsScoreSingleWeightGroupCombined ( SQ_Model  pModel,
SQ_FloatVector pMaturity,
SQ_IntVector pBatchIx,
SQ_StringVector pPhaseIterations,
SQ_WeightType  eWeightType,
int  iComponent,
SQ_ReconstructState  bReconstruct,
SQ_VectorData pVectorData 
)

Aligned Scores single weight group contribution. In batch level projects created from score variables, the Combined Contribution matrix can be created. Contribution is used to understand how an observation differs from the others in an X score(t) or in DModX. See the document "SIMCA-Q Interface Description.pdf" for a more detailed description on contributions. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]pMaturityA vector with the aligned maturity for which the contributions are to be calculated (to observation).
[in]pBatchIxA vector with the batch index to get the contribution for. for which the contributions are to be calculated (to observation). Must be the same length as the second maturity vector.
[in]pPhaseIterationsA vector of phase iteration names for which you would like to get contributions. If the project doesn't have a phase iteration ID the parameter is ignored. Phase iteration is also ignored for batch indexes < 1, any value can be used
[in]eWeightTypeThe type of weight. If the model is a PCA model this parameter must be Normalized, Raw, RX or P. If the model is a PLS model this parameter can be any weight defined in SQ_WeightType.
[in]iComponentThe component of the weight. Ignored if eWeightType=Normalized or Raw.
[in]bReconstructIf the project is a wavelet spectral compressed project and this parameter is true the returned matrix will be back transformed to the original domain.
[out]pVectorDataA pointer to the combined aligned Score single weight contribution results. Number of rows in matrix = 1. Number of columns in matrix = number of x-variables in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedDModX()

SQ_ErrorCode SQ_GetAlignedDModX ( SQ_Model  pModel,
int  iComponent,
SQ_NormalizedState  bNormalized,
SQ_ModelingPowerWeightedState  bModelingPowerWeighted,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned DModX from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bNormalizedIf SQ_True, the results will be in units of standard deviation of the pooled RSD of the model If SQ_False, they will be in absolute values.
[in]bModelingPowerWeightedIf SQ_True, the function will weight the residuals by the modeling power of the variables.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned DModX results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedDModXAverageBatch()

SQ_ErrorCode SQ_GetAlignedDModXAverageBatch ( SQ_Model  pModel,
int  iComponent,
SQ_NormalizedState  bNormalized,
SQ_ModelingPowerWeightedState  bModelingPowerWeighted,
SQ_VectorData pVectorData 
)

Retrieves the aligned DModX average batch from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bNormalizedIf SQ_True, the results will be in units of standard deviation of the pooled RSD of the model If SQ_False, they will be in absolute values.
[in]bModelingPowerWeightedIf SQ_True, the function will weight the residuals by the modeling power of the variables.
[out]pVectorDataA pointer to the aligned DModX average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedDModXOOCSum()

SQ_ErrorCode SQ_GetAlignedDModXOOCSum ( SQ_Model  pModel,
int  iComponent,
float  fLimit,
SQ_VectorData pVectorData 
)

Out Of Control for DModX

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]fLimitThe sigma limit.
[out]pVectorDataA pointer to the DModX OOC results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedDModXStdDevBatch()

SQ_ErrorCode SQ_GetAlignedDModXStdDevBatch ( SQ_Model  pModel,
int  iComponent,
SQ_NormalizedState  bNormalized,
SQ_ModelingPowerWeightedState  bModelingPowerWeighted,
SQ_VectorData pVectorData 
)

Retrieves the aligned DModX stddev batch from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bNormalizedIf SQ_True, the results will be in units of standard deviation of the pooled RSD of the model If SQ_False, they will be in absolute values.
[in]bModelingPowerWeightedIf SQ_True, the function will weight the residuals by the modeling power of the variables.
[out]pVectorDataA pointer to the aligned DModX StdDev results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedT()

SQ_ErrorCode SQ_GetAlignedT ( SQ_Model  pModel,
int  iComponent,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned T from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned T results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedT2Range()

SQ_ErrorCode SQ_GetAlignedT2Range ( SQ_Model  pModel,
int  iCompFrom,
int  iCompTo,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned T2Range from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iCompFromThe first component in the requested range.
[in]iCompToThe last component in the requested range. Use -1 if you want it to be the last component in model. This is the preferred way for OPLS which always requires the last component.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned T2Range results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedT2RangeAverageBatch()

SQ_ErrorCode SQ_GetAlignedT2RangeAverageBatch ( SQ_Model  pModel,
int  iCompFrom,
int  iCompTo,
SQ_VectorData pVectorData 
)

Retrieves the aligned T2Range average batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iCompFromThe first component in the requested range.
[in]iCompToThe last component in the requested range. Use -1 if you want it to be the last component in model. This is the preferred way for OPLS which always requires the last component.
[out]pVectorDataA pointer to the aligned T2Range average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedT2RangeOOCSum()

SQ_ErrorCode SQ_GetAlignedT2RangeOOCSum ( SQ_Model  pModel,
int  iCompFrom,
int  iCompTo,
SQ_VectorData pVectorData 
)

Out Of Control for T2Range

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iCompFromThe first component in the requested range.
[in]iCompToThe last component in the requested range. Use -1 if you want it to be the last component in model. This is the preferred way for OPLS which always requires the last component.
[out]pVectorDataA pointer to the T2Range OOC results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedT2RangeStdDevBatch()

SQ_ErrorCode SQ_GetAlignedT2RangeStdDevBatch ( SQ_Model  pModel,
int  iCompFrom,
int  iCompTo,
SQ_VectorData pVectorData 
)

Retrieves the aligned T2Range stddev batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iCompFromThe first component in the requested range.
[in]iCompToThe last component in the requested range. Use -1 if you want it to be the last component in model. This is the preferred way for OPLS which always requires the last component.
[out]pVectorDataA pointer to the aligned T2Range StdDev batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedTAverageBatch()

SQ_ErrorCode SQ_GetAlignedTAverageBatch ( SQ_Model  pModel,
int  iComponent,
SQ_VectorData pVectorData 
)

Retrieves the aligned T average batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[out]pVectorDataA pointer to the aligned T average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedTimeMaturity()

SQ_ErrorCode SQ_GetAlignedTimeMaturity ( SQ_Model  pModel,
SQ_VectorData pVectorData 
)

The Time or Maturity variable(s). Determining the end point of a Batch/phase and used as Y in the training set model. This variable is used to align batch/phase to the average length.

Parameters
[in]pModelThe Batch Evolution Model to use.
[out]pVectorDataA pointer to the aligned Time/Maturity results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedTo()

SQ_ErrorCode SQ_GetAlignedTo ( SQ_Model  pModel,
int  iComponent,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned To from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned To results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedToAverageBatch()

SQ_ErrorCode SQ_GetAlignedToAverageBatch ( SQ_Model  pModel,
int  iComponent,
SQ_VectorData pVectorData 
)

Retrieves the aligned To average batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[out]pVectorDataA pointer to the aligned To average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedTOOCSum()

SQ_ErrorCode SQ_GetAlignedTOOCSum ( SQ_Model  pModel,
int  iComponent,
float  fHighLimit,
float  fLowLimit,
SQ_VectorData pVectorData 
)

Out Of Control for T

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]fHighLimitThe higher sigma limit.
[in]fLowLimitThe lower sigma limit.
[out]pVectorDataA pointer to the T OOC results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedToStdDevBatch()

SQ_ErrorCode SQ_GetAlignedToStdDevBatch ( SQ_Model  pModel,
int  iComponent,
SQ_VectorData pVectorData 
)

Retrieves the aligned To stddev batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[out]pVectorDataA pointer to the aligned To StdDev batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedTStdDevBatch()

SQ_ErrorCode SQ_GetAlignedTStdDevBatch ( SQ_Model  pModel,
int  iComponent,
SQ_VectorData pVectorData 
)

Retrieves the aligned T stddev batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[out]pVectorDataA pointer to the aligned T StdDev batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedXVar()

SQ_ErrorCode SQ_GetAlignedXVar ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
int  iXTerm,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned XVar from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the x-values in the (unscaled) metric of the dataset. If SQ_False, the returned x-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the x-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case x-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the x-values in the unscaled untransformed metric of the workset. If SQ_False the returned x-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned x-values will always be unscaled irrespective of the value of bUnscaled.
[in]iXTermThe X term to use.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned XVar results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedXVarAverageBatch()

SQ_ErrorCode SQ_GetAlignedXVarAverageBatch ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
int  iXTerm,
SQ_VectorData pVectorData 
)

Retrieves the aligned XVar average batch from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the x-values in the (unscaled) metric of the dataset. If SQ_False, the returned x-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the x-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case x-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the x-values in the unscaled untransformed metric of the workset. If SQ_False the returned x-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned x-values will always be unscaled irrespective of the value of bUnscaled.
[in]iXTermThe X term to use.
[out]pVectorDataA pointer to the aligned XVar Average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedXVarOOCSum()

SQ_ErrorCode SQ_GetAlignedXVarOOCSum ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
int  iColumnXIndex,
float  fHighLimit,
float  fLowLimit,
SQ_VectorData pVectorData 
)

Out Of Control for XVar

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the x-values in the (unscaled) metric of the dataset. If SQ_False, the returned x-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the x-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case x-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the x-values in the unscaled untransformed metric of the workset. If SQ_False the returned x-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned x-values will always be unscaled irrespective of the value of bUnscaled.
[in]iColumnXIndexThe index of the X-columns.
[in]fHighLimitThe higher sigma limit.
[in]fLowLimitThe lower sigma limit.
[out]pVectorDataA pointer to the XVar OOC results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedXVarStdDevBatch()

SQ_ErrorCode SQ_GetAlignedXVarStdDevBatch ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
int  iXTerm,
SQ_VectorData pVectorData 
)

Retrieves the aligned XVar stddev batch from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the x-values in the (unscaled) metric of the dataset. If SQ_False, the returned x-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the x-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case x-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the x-values in the unscaled untransformed metric of the workset. If SQ_False the returned x-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned x-values will always be unscaled irrespective of the value of bUnscaled.
[in]iXTermThe X term to use.
[out]pVectorDataA pointer to the aligned XVar StdDev batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYPred()

SQ_ErrorCode SQ_GetAlignedYPred ( SQ_Model  pModel,
int  iComponent,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned YPred from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned YPred results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYPredAverageBatch()

SQ_ErrorCode SQ_GetAlignedYPredAverageBatch ( SQ_Model  pModel,
int  iComponent,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
SQ_VectorData pVectorData 
)

Retrieves the aligned YPred average batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[out]pVectorDataA pointer to the aligned YPred average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYPredOOCSum()

SQ_ErrorCode SQ_GetAlignedYPredOOCSum ( SQ_Model  pModel,
int  iComponent,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
float  fHighLimit,
float  fLowLimit,
SQ_VectorData pVectorData 
)

Out Of Control for YPred

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[in]fHighLimitThe higher sigma limit.
[in]fLowLimitThe lower sigma limit.
[out]pVectorDataA pointer to the YPred OOC results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYPredStdDevBatch()

SQ_ErrorCode SQ_GetAlignedYPredStdDevBatch ( SQ_Model  pModel,
int  iComponent,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
SQ_VectorData pVectorData 
)

Retrieves the aligned YPred stddev batch from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iComponentThe component to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[out]pVectorDataA pointer to the aligned YPred StdDev batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYVar()

SQ_ErrorCode SQ_GetAlignedYVar ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
SQ_IntVector pBatches,
SQ_VectorData pVectorData 
)

Retrieves the aligned YVar from the model. The function fails if the model doesn't have any components.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[in]pBatchesA list of batches that exist in the model, NULL if all batches that exist in the model should be used.
[out]pVectorDataA pointer to the aligned YVar results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYVarAverageBatch()

SQ_ErrorCode SQ_GetAlignedYVarAverageBatch ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
SQ_VectorData pVectorData 
)

Retrieves the aligned YVar average batch from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[out]pVectorDataA pointer to the aligned YVar average batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetAlignedYVarStdDevBatch()

SQ_ErrorCode SQ_GetAlignedYVarStdDevBatch ( SQ_Model  pModel,
SQ_UnscaledState  bUnscaled,
SQ_BacktransformedState  bBackTransformed,
SQ_VectorData pVectorData 
)

Retrieves the aligned YVar stddev batch from the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]bUnscaledIf SQ_True, the function will return the y-values in the (unscaled) metric of the dataset. If SQ_False, the returned y-values will be in the scaled and centered metric of the workset. Note that if bBackTransformed is SQ_False, the y-values will still be transformed. Note also that if bBackTransformed is SQ_True, this parameter is ignored. In this case y-values will always be unscaled.
[in]bBackTransformedIf SQ_True, the function will return the y-values in the unscaled untransformed metric of the workset. If SQ_False the returned y-values will be transformed in the same way as the workset. Note that if this variable is SQ_True, the returned y-values will always be unscaled irrespective of the value of bUnscaled.
[out]pVectorDataA pointer to the aligned YVar StdDev batch results.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetBEMLimits()

SQ_ErrorCode SQ_GetBEMLimits ( SQ_Model  pModel,
SQ_LimitType  eLimitType,
int  iCompFrom,
int  iCompTo,
SQ_VectorData pVectorData 
)

A request to get the batch evolution model limits.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]eLimitTypeThe type of the requested limit (Score, DModX or T2Range)
[in]iCompFromThe "start" component, if only one component it should be given here.
[in]iCompToThe "end" component.
[out]pVectorDataA pointer to the Limits results. Number of rows in matrix = 2 (first is Mean and second StdDev) Number of columns in matrix = The aligned Time/maturity vector.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetModelBatchName()

SQ_ErrorCode SQ_GetModelBatchName ( SQ_Model  pModel,
int  iBatchIx,
char *  szBatchName,
int  iBufferLength 
)

Retrieves the name of a batch in a model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in]iBatchIxThe batch index we want the name for.
[in,out]szBatchNameThe name of the batch. The user is responsible to allocate and deallocate the buffer, UTF-8 encoded.
[in]iBufferLengthThe length of the buffer.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetModelNumberOfBatches()

SQ_ErrorCode SQ_GetModelNumberOfBatches ( SQ_Model  pModel,
int *  piNrOfBatches 
)

Retrieves the number of batches in the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[out]piNrOfBatchesThe number of batches in the model.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_GetPhaseName()

SQ_ErrorCode SQ_GetPhaseName ( SQ_Model  pModel,
char *  szPhaseName,
int  iBufferLength 
)

Retrieves the name of the phase connected with the model.

Parameters
[in]pModelThe Batch Evolution Model to use.
[in,out]szPhaseNameThe name of the phase. The user is responsible to allocate and deallocate the buffer, UTF-8 encoded.
[in]iBufferLengthThe length of the buffer.
Returns
Returns SQ_E_OK if success or an error code

◆ SQ_IsBatchEvolutionModel()

SQ_ErrorCode SQ_IsBatchEvolutionModel ( SQ_Model  pModel,
SQ_Bool bIsBEM 
)

An inquiry whether the model is a Batch Evolution Model.

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

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