Classes | Typedefs | Enumerations
SQMDefines.h File Reference
#include "SQDef.h"
#include "SQErrorCodes.h"

Go to the source code of this file.

Classes

struct  tagSQ_ProjectOptions
 
struct  SQ_WSScaleInfoStruct
 
struct  SQ_WSTransformInfoStruct
 

Typedefs

typedef enum SQ_POScaleTypesEnum SQ_POScaleTypes
 
typedef struct tagSQ_ProjectOptions SQ_ProjectOptions
 
typedef enum SQ_WSBaseScalingTypeEnum SQ_WSBaseScalingType
 
typedef enum SQ_WSBlockScalingTypeEnum SQ_WSBlockScalingType
 
typedef enum SQ_WSCenteringEnum SQ_WSCentering
 
typedef enum SQ_WSTransformTypeEnum SQ_WSTransformType
 
typedef struct SQ_WSScaleInfoStruct SQ_WSScaleInfo
 
typedef enum SQ_WSPowerExponentEnum SQ_WSPowerExponent
 
typedef struct SQ_WSTransformInfoStruct SQ_WSTransformInfo
 
typedef enum SQ_CVGroupByEnum SQ_CVGroupBy
 
typedef enum SQ_HierarchicalEnum SQ_Hierarchical
 
typedef enum SQ_FilterTypeEnum SQ_FilterType
 
typedef enum SQ_TSFilterTypeEnum SQ_TSFilterType
 
typedef enum SQ_FilterScalingTypeEnum SQ_FilterScalingType
 
typedef enum SQ_FilterPolynomialOrderEnum SQ_FilterPolynomialOrder
 
typedef enum SQ_FilterDerivateOrderEnum SQ_FilterDerivateOrder
 
typedef enum SQ_FilterDetrendModeEnum SQ_FilterDetrendMode
 
typedef enum SQ_FilterWaveletFunctionEnum SQ_FilterWaveletFunction
 
typedef enum SQ_FilterCompressionMethodEnum SQ_FilterCompressionMethod
 

Enumerations

enum  SQ_POScaleTypesEnum {
  SQ_POScaleNone, SQ_POScaleUV, SQ_POScaleUVN, SQ_POScalePar,
  SQ_POScaleParN, SQ_POScaleCtr
}
 
enum  SQ_WSBaseScalingTypeEnum {
  SQ_WSScaleNone, SQ_WSScaleUnitVariance, SQ_WSScalePareto, SQ_WSScaleFrozen,
  SQ_WSScaleLag, SQ_WSScaleExpanded, SQ_WSScalePercentOfCenter, SQ_WSScaleInverseStandardDeviation,
  SQ_WSScaleStandardDeviation
}
 
enum  SQ_WSBlockScalingTypeEnum { SQ_WSBlockScaleNone, SQ_WSBlockScaleSquareRoot, SQ_WSBlockScaleFourthRoot }
 
enum  SQ_WSCenteringEnum { SQ_WSCenterNone, SQ_WSCenterAuto, SQ_WSCenterFixed, SQ_WSCenterFrozen }
 
enum  SQ_WSTransformTypeEnum {
  SQ_WSTransformNone, SQ_WSTransformLinear, SQ_WSTransformLog, SQ_WSTransformNegLog,
  SQ_WSTransformLogIt, SQ_WSTransformExp, SQ_WSTransformPower
}
 
enum  SQ_WSPowerExponentEnum {
  SQ_WSExpInvSquare, SQ_WSExpInverse, SQ_WSExpInvSquareRoot, SQ_WSExpInvFourthRoot,
  SQ_WSExpFourthRoot, SQ_WSExpSquareRoot, SQ_WSExpIdentity, SQ_WSExpSquare
}
 
enum  SQ_CVGroupByEnum { SQ_CVSimilar, SQ_CVDisSimilar, SQ_CVGroupNum }
 
enum  SQ_HierarchicalEnum { SQ_HierarchicalScores, SQ_HierarchicalResiduals, SQ_HierarchicalBoth }
 
enum  SQ_FilterTypeEnum {
  SQ_FilterMSC, SQ_FilterOSC, SQ_FilterSNV, SQ_FilterWCS,
  SQ_FilterDerivate, SQ_FilterSavitzky, SQ_FilterEWMA, SQ_FilterRowCenter
}
 
enum  SQ_TSFilterTypeEnum { SQ_TSFilterWDS, SQ_TSFilterWDTS }
 
enum  SQ_FilterScalingTypeEnum { SQ_FilterScaleNone =1, SQ_FilterScaleCenter, SQ_FilterScalePareto, SQ_FilterScaleUnitVariance }
 
enum  SQ_FilterPolynomialOrderEnum { SQ_FilterQuadratic =2, SQ_FilterCubic =3 }
 
enum  SQ_FilterDerivateOrderEnum { SQ_FilterFirstOrder =1, SQ_FilterSecondOrder =2, SQ_FilterThirdOrder =3 }
 
enum  SQ_FilterDetrendModeEnum { SQ_FilterDetrendNone =0, SQ_FilterDetrendMean, SQ_FilterDetrendLinear }
 
enum  SQ_FilterWaveletFunctionEnum {
  SQ_FilterFunBeylkin =0, SQ_FilterFunCoiflet, SQ_FilterFunDaubechies, SQ_FilterFunSymmlet,
  SQ_FilterFunBiorthogonal1, SQ_FilterFunBiorthogonal2, SQ_FilterFunBiorthogonal3, SQ_FilterFunBiorthogonal4,
  SQ_FilterFunBiorthogonal5, SQ_FilterFunBiorthogonal6
}
 
enum  SQ_FilterCompressionMethodEnum { SQ_FilterCompDWT =0, SQ_FilterCompBestBasis }
 

Typedef Documentation

◆ SQ_CVGroupBy

Indicates how to divide observations into different groups.

◆ SQ_FilterCompressionMethod

Wavelet compression method.

◆ SQ_FilterDerivateOrder

Derivate filter derivation order.

◆ SQ_FilterDetrendMode

Wavelet filter detrend mode.

◆ SQ_FilterPolynomialOrder

Filter polynomial order.

◆ SQ_FilterScalingType

Filter scaling type. For further information see the SIMCA manual and SQMF_SetScaling.

◆ SQ_FilterType

Types of spectral filters that can be used.

◆ SQ_FilterWaveletFunction

Wavelet filter functions.

◆ SQ_Hierarchical

Indicates what variables should be added to the workset from the hierarchical base model.

◆ SQ_POScaleTypes

Scale enum used in Project Options.

◆ SQ_ProjectOptions

A struct that is used to set and get project options.

◆ SQ_TSFilterType

Types of time series filters that can be used.

◆ SQ_WSBaseScalingType

Base scaling type. For further information see the SIMCA manual and SQ_SetScaling.

◆ SQ_WSBlockScalingType

Block scaling type. For further information see the SIMCA manual and SQ_SetScaling.

◆ SQ_WSCentering

Centering types. For further information see the SIMCA manual and SQ_SetScaling.

◆ SQ_WSPowerExponent

Allowed values for the exponent in power transform

◆ SQ_WSScaleInfo

Struct used to get and set the scaling of a variable.

◆ SQ_WSTransformInfo

Struct for setting and getting variable transform

◆ SQ_WSTransformType

Transform types. For further information see the SIMCA manual and SQ_SetScaling.

Enumeration Type Documentation

◆ SQ_CVGroupByEnum

Indicates how to divide observations into different groups.

Enumerator
SQ_CVSimilar 

Group similar observations in the same group.

SQ_CVDisSimilar 

Group dissimilar observations in the same group.

SQ_CVGroupNum 

Group observations with the same value in the same group.

◆ SQ_FilterCompressionMethodEnum

Wavelet compression method.

Enumerator
SQ_FilterCompDWT 

Compression by DWT

SQ_FilterCompBestBasis 

Compression by Best Basis

◆ SQ_FilterDerivateOrderEnum

Derivate filter derivation order.

Enumerator
SQ_FilterFirstOrder 

First derivate

SQ_FilterSecondOrder 

Second derivate

SQ_FilterThirdOrder 

Third derivate

◆ SQ_FilterDetrendModeEnum

Wavelet filter detrend mode.

Enumerator
SQ_FilterDetrendNone 

No detrend

SQ_FilterDetrendMean 

Detrend by mean value

SQ_FilterDetrendLinear 

Detrend linear

◆ SQ_FilterPolynomialOrderEnum

Filter polynomial order.

Enumerator
SQ_FilterQuadratic 

Quadratic polynomial order

SQ_FilterCubic 

Cubic polynomial order

◆ SQ_FilterScalingTypeEnum

Filter scaling type. For further information see the SIMCA manual and SQMF_SetScaling.

Enumerator
SQ_FilterScaleNone 

No scaling

SQ_FilterScaleCenter 

Scaled by the center

SQ_FilterScalePareto 

Scaled by the inverse of the square root of the standard deviation.

SQ_FilterScaleUnitVariance 

Scaled by the inverse of the standard deviation.

◆ SQ_FilterTypeEnum

Types of spectral filters that can be used.

Enumerator
SQ_FilterMSC 

A MSC filter.

SQ_FilterOSC 

A OSC filter.

SQ_FilterSNV 

A SNV filter.

SQ_FilterWCS 

A WCS filter.

SQ_FilterDerivate 

A Derivate filter.

SQ_FilterSavitzky 

A Savitzky-Golay filter.

SQ_FilterEWMA 

A EWMA filter.

SQ_FilterRowCenter 

A Row Center filter.

◆ SQ_FilterWaveletFunctionEnum

Wavelet filter functions.

Enumerator
SQ_FilterFunBeylkin 

Wavelet function Beylkin

SQ_FilterFunCoiflet 

Wavelet function Coiflet

SQ_FilterFunDaubechies 

Wavelet function Daubechies

SQ_FilterFunSymmlet 

Wavelet function Symmlet

SQ_FilterFunBiorthogonal1 

Wavelet function Biorthogonal1

SQ_FilterFunBiorthogonal2 

Wavelet function Biorthogonal2

SQ_FilterFunBiorthogonal3 

Wavelet function Biorthogonal3

SQ_FilterFunBiorthogonal4 

Wavelet function Biorthogonal4

SQ_FilterFunBiorthogonal5 

Wavelet function Biorthogonal5

SQ_FilterFunBiorthogonal6 

Wavelet function Biorthogonal6

◆ SQ_HierarchicalEnum

Indicates what variables should be added to the workset from the hierarchical base model.

Enumerator
SQ_HierarchicalScores 

The scores will be added as variables.

SQ_HierarchicalResiduals 

The residuals will be added as variables.

SQ_HierarchicalBoth 

Both scores and residuals will be added as variables.

◆ SQ_POScaleTypesEnum

Scale enum used in Project Options.

Enumerator
SQ_POScaleNone 

No scaling

SQ_POScaleUV 

Centered and scaled to Unit Variance.

SQ_POScaleUVN 

Scaled to Unit Variance (not centered).

SQ_POScalePar 

Centered and scaled to Pareto Variance.

SQ_POScaleParN 

Scaled to Pareto Variance (not centered).

SQ_POScaleCtr 

Centered but not scaled.

◆ SQ_TSFilterTypeEnum

Types of time series filters that can be used.

Enumerator
SQ_TSFilterWDS 

A WDS filter.

SQ_TSFilterWDTS 

A WDTS filter.

◆ SQ_WSBaseScalingTypeEnum

Base scaling type. For further information see the SIMCA manual and SQ_SetScaling.

Enumerator
SQ_WSScaleNone 

No scaling

SQ_WSScaleUnitVariance 

Scaled by the inverse of the standard deviation.

SQ_WSScalePareto 

Scaled by the inverse of the square root of the standard deviation.

SQ_WSScaleFrozen 

The scaling weight and offset is set to a fixed value.

SQ_WSScaleLag 

Default scaling for lagged variables. Can only be used for lagged variables.

SQ_WSScaleExpanded 

Scaling type for expanded variables. Expanded variables will always have this type and no other type of variable can be set to use this type of scaling.

SQ_WSScalePercentOfCenter 

The inverse of a percentage of the mean.

SQ_WSScaleInverseStandardDeviation 

The scaling weight and center is set to a fixed value.

SQ_WSScaleStandardDeviation 

The scaling weight and center can be set to a fixed value.

◆ SQ_WSBlockScalingTypeEnum

Block scaling type. For further information see the SIMCA manual and SQ_SetScaling.

Enumerator
SQ_WSBlockScaleNone 

The variable is not block scaled.

SQ_WSBlockScaleSquareRoot 

Scale by the inverse of the square root of the number of variables in the block

SQ_WSBlockScaleFourthRoot 

Scale by the inverse of the fourth root of the number of variables in the block

◆ SQ_WSCenteringEnum

Centering types. For further information see the SIMCA manual and SQ_SetScaling.

Enumerator
SQ_WSCenterNone 

Do not center the variable.

SQ_WSCenterAuto 

Center by subtracting the arithmetic mean of the variable.

SQ_WSCenterFixed 

Center by subtracting a fixed value.

SQ_WSCenterFrozen 

The center is a fixed value.

◆ SQ_WSPowerExponentEnum

Allowed values for the exponent in power transform

Enumerator
SQ_WSExpInvSquare 

-2

SQ_WSExpInverse 

-1

SQ_WSExpInvSquareRoot 

-0.5

SQ_WSExpInvFourthRoot 

-0.25

SQ_WSExpFourthRoot 

0.25

SQ_WSExpSquareRoot 

0.5

SQ_WSExpIdentity 

1

SQ_WSExpSquare 

2

◆ SQ_WSTransformTypeEnum

Transform types. For further information see the SIMCA manual and SQ_SetScaling.

Enumerator
SQ_WSTransformNone 

The variable is not transformed.

SQ_WSTransformLinear 

Linear transform. a*X+b

SQ_WSTransformLog 

Log10 transform. log(a*X+b)

SQ_WSTransformNegLog 

Negative log10 transform. -log(a*X+b)

SQ_WSTransformLogIt 

log10((X-a)/(b-X))

SQ_WSTransformExp 

Natural exponent. e^(a*X+b)

SQ_WSTransformPower 

(a*X+b)^C Note that


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