Public Attributes | List of all members
SQ_WSScaleInfoStruct Struct Reference

#include <SQMDefines.h>

Public Attributes

SQ_WSBaseScalingType eBaseScalingType
 
float fScalingWeight
 
SQ_WSCentering eCentering
 
float fCenter
 
float fScaleModifier
 
SQ_WSBlockScalingType eBlockScalingType
 
int iBlockScalingBlock
 

Detailed Description

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

Member Data Documentation

◆ eBaseScalingType

SQ_WSBaseScalingType SQ_WSScaleInfoStruct::eBaseScalingType

The base scaling type. If this parameter is SQMWS_ScaleFrozen, SQMWS_ScaleStandardDeviation or SQMWS_ScaleInverseStandardDeviation the base scaling weight is fScalingWeight and fCenter is the center and all other members are ignored. If it is SQMWS_ScaleLag or SQMWS_ScaleExpanded all other members are ignored except fScaleModifier, eBlockScalingType and iBlockScalingBlock. If the parameter is SQMWS_ScalePercentOfCenter the percent of center is the fScaleModifier and fCenter is the center and all other members are ignored. Note that SQMWS_ScaleExpanded can not be used when setting the scaling weight of a variable. Expanded variables always have scaling type SQMWS_ScaleExpanded which can not be changed. Note also that SQMWS_ScaleLag can only be set for lagged non expanded variables.

◆ eBlockScalingType

SQ_WSBlockScalingType SQ_WSScaleInfoStruct::eBlockScalingType

The block scaling type. If this parameter is not equal to SQMWS_BlockScaleNone, iBlockScalingBlock is the block scaling block used for this variable.

◆ eCentering

SQ_WSCentering SQ_WSScaleInfoStruct::eCentering

The centering type. If this parameter is SQMWS_CenterFixed fCenter will be used as the center value, otherwise it will be calculated from the data.

◆ fCenter

float SQ_WSScaleInfoStruct::fCenter

The center value if eCentering is equal to SQMWS_CenterFixed or if eBaseScalingType is equal to SQMWS_ScaleFrozen, SQMWS_ScalePercentOfCenter, SQMWS_ScaleStandardDeviation or SQMWS_ScaleInverseStandardDeviation.
Otherwise this member is ignored.

◆ fScaleModifier

float SQ_WSScaleInfoStruct::fScaleModifier

An additional modifier of the base scaling weight. This parameter is ignored if eBaseScalingType equals SQMWS_ScaleFrozen. If eBaseScalingType is equal to SQMWS_ScalePercentOfCenter this is the percentage used.

◆ fScalingWeight

float SQ_WSScaleInfoStruct::fScalingWeight

The base scaling weight if eBaseScalingType is equal to SQMWS_ScaleFrozen, SQMWS_ScaleStandardDeviation or SQMWS_ScaleInverseStandardDeviation. Otherwise this member is ignored.

◆ iBlockScalingBlock

int SQ_WSScaleInfoStruct::iBlockScalingBlock

The block scaling block if eBlockScalingType is not equal to SQMWS_BlockScaleNone, otherwise this member is ignored.


The documentation for this struct was generated from the following file:

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