SQMFilter.h
Go to the documentation of this file.
1 /*
2 Copyright (C) Sartorius Stedim Data Analytics AB 2017 -
3 */
4 #ifndef _SQMFILTER_H_
5 #define _SQMFILTER_H_
6 
7 #include "SQDef.h"
8 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
16 #ifdef _WIN32
17 #pragma pack(push, 8)
18 #endif
19 
20 #include "SQErrorCodes.h"
21 #include "SQProject.h"
22 #include "SQMDefines.h"
23 #include "SQControlCharts.h"
25 
30  typedef struct tagSQ_FilterHandle
31  {
33  void* reserved;
34  } *SQ_Filter;
35 
48  SQCEXPORT SQ_ErrorCode SQCDECL SQ_CreateSpectralFilter(SQ_Project hProject, int iDatasetNumber, SQ_Filter* pFilterHandle);
49 
59  SQCEXPORT SQ_ErrorCode SQCDECL SQ_CreateTimeSeriesFilter(SQ_Project hProject, SQ_TSFilterType eFilter, int iDatasetNumber, SQ_Filter* pFilterHandle);
60 
74  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetData(SQ_Filter hFilter, SQ_IntVector* oXVarNums, SQ_IntVector* oYVarNums, SQ_IntVector* oObsNums);
75 
89  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetTransformation(SQ_Filter hFilter, SQ_IntVector oVarNums, int iVarNums, SQ_WSTransformInfo oTransInfo);
90 
105  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetScale(SQ_Filter hFilter, SQ_IntVector oVarNums, int iVarNums, SQ_FilterScalingType eScale);
106 
116  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetLambdaValue(SQ_Filter hFilter, float fLambda);
117 
127  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetEWMAType(SQ_Filter hFilter, SQ_EWMAType eEWMAType);
128 
139  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetPolynomialOrder(SQ_Filter hFilter, SQ_FilterPolynomialOrder eOrder, SQ_Bool bDerivate);
140 
150  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDerivateOrder(SQ_Filter hFilter, SQ_FilterDerivateOrder eDerivateOrder);
151 
163  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetSubModelPoints(SQ_Filter hFilter, int iSubModelPoints, SQ_Bool bDerivate);
164 
174  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDeltaX(SQ_Filter hFilter, float fDeltaX);
175 
176 
186  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetAngle(SQ_Filter hFilter, float* pfAngle);
187 
197  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetRemainingSS(SQ_Filter hFilter, float* pfRemainingSS);
198 
208  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetEigenvalue(SQ_Filter hFilter, float* pfEigenvalue);
209 
218  SQCEXPORT SQ_ErrorCode SQCDECL SQ_NextFilterComponent(SQ_Filter hFilter);
219 
228  SQCEXPORT SQ_ErrorCode SQCDECL SQ_RemoveFilterComponent(SQ_Filter hFilter);
229 
230 
240  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDetrendMode(SQ_Filter hFilter, SQ_FilterDetrendMode eMode);
241 
253  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetWaveletFunction(SQ_Filter hFilter, SQ_FilterWaveletFunction eFunction, int iOrder);
254 
265 
278  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetVarianceUsePadding(SQ_Filter hFilter, SQ_Bool bPadding);
279 
288  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetEnergyRetainedByDetailLevel(SQ_Filter hFilter);
289 
301  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDetailLevelNumOfIndexes(SQ_Filter hFilter, int* pnIndexes);
302 
312  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDetailLevelIndexes(SQ_Filter hFilter, SQ_IntVector nVecDetailLevels);
313 
325  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDetailLevelData(SQ_Filter hFilter, int iDetailLevelIndex, int* pnCoeffs, float* pfRetained);
326 
336  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetDetailLevelTotalRetained(SQ_Filter hFilter, float* pfRetained);
337 
349  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDetailLevelDecimation(SQ_Filter hFilter, int iDecNum);
350 
359  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetTargetVariable(SQ_Filter hFilter, int iTargetVariable);
360 
370  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDataset(SQ_Filter hFilter, int iDatasetNumber);
371 
382  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetVarianceCoeffs(SQ_Filter hFilter, int iCoeffs, float* pfRetained);
383 
391  SQCEXPORT SQ_ErrorCode SQCDECL SQ_StartFiltering(SQ_Filter hFilter);
392 
406  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetChainOrder(SQ_Filter hFilter, SQ_FilterType eFilter);
407 
416  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetChainOrderPlugin(SQ_Filter hFilter, const char* szPluginFilter);
417 
424  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetPluginFilterNames(SQ_StringVector* pvecNames);
425 
435  SQCEXPORT SQ_ErrorCode SQCDECL SQ_GetPluginFilterOptions(SQ_Filter hFilter, const char* szPluginName, char* pszOptions, int iBufferLen);
436 
445  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetPluginFilterOptions(SQ_Filter hFilter, const char* szPluginName, const char* szOptions);
446 
454  SQCEXPORT SQ_ErrorCode SQCDECL SQ_SetDatasetName(SQ_Filter hFilter, const char* strName);
455 
462  SQCEXPORT SQ_ErrorCode SQCDECL SQ_FinishFiltering(SQ_Filter hFilter);
463 
470  SQCEXPORT SQ_ErrorCode SQCDECL SQ_ReleaseFilterHandle(SQ_Filter hFilter);
471 
473 
474 #ifdef _WIN32
475 #pragma pack(pop)
476 #endif
477 
478 #ifdef __cplusplus
479 }
480 #endif /*__cplusplus*/
481 
482 #endif /* _SQMFILTER_H_ */
SQ_StartFiltering
SQ_ErrorCode SQ_StartFiltering(SQ_Filter hFilter)
SQ_SetDatasetName
SQ_ErrorCode SQ_SetDatasetName(SQ_Filter hFilter, const char *strName)
tagSQ_ProjectHandle
Definition: SQProject.h:24
SQ_FilterWaveletFunction
enum SQ_FilterWaveletFunctionEnum SQ_FilterWaveletFunction
SQ_SetDetailLevelIndexes
SQ_ErrorCode SQ_SetDetailLevelIndexes(SQ_Filter hFilter, SQ_IntVector nVecDetailLevels)
SQ_SetEnergyRetainedByVariance
SQ_ErrorCode SQ_SetEnergyRetainedByVariance(SQ_Filter hFilter, SQ_FilterCompressionMethod eMethod)
tagSQ_FilterHandle
Definition: SQMFilter.h:30
SQ_SetChainOrder
SQ_ErrorCode SQ_SetChainOrder(SQ_Filter hFilter, SQ_FilterType eFilter)
SQ_SetEWMAType
SQ_ErrorCode SQ_SetEWMAType(SQ_Filter hFilter, SQ_EWMAType eEWMAType)
SQ_GetEigenvalue
SQ_ErrorCode SQ_GetEigenvalue(SQ_Filter hFilter, float *pfEigenvalue)
SQ_FilterPolynomialOrder
enum SQ_FilterPolynomialOrderEnum SQ_FilterPolynomialOrder
SQ_Bool
enum SQ_BoolEnum SQ_Bool
SQ_SetDerivateOrder
SQ_ErrorCode SQ_SetDerivateOrder(SQ_Filter hFilter, SQ_FilterDerivateOrder eDerivateOrder)
SQControlCharts.h
SQ_WSTransformInfoStruct
Definition: SQMDefines.h:191
SQ_CreateSpectralFilter
SQ_ErrorCode SQ_CreateSpectralFilter(SQ_Project hProject, int iDatasetNumber, SQ_Filter *pFilterHandle)
SQ_GetDetailLevelData
SQ_ErrorCode SQ_GetDetailLevelData(SQ_Filter hFilter, int iDetailLevelIndex, int *pnCoeffs, float *pfRetained)
SQ_GetPluginFilterOptions
SQ_ErrorCode SQ_GetPluginFilterOptions(SQ_Filter hFilter, const char *szPluginName, char *pszOptions, int iBufferLen)
SQ_SetVarianceCoeffs
SQ_ErrorCode SQ_SetVarianceCoeffs(SQ_Filter hFilter, int iCoeffs, float *pfRetained)
SQ_Filter
struct tagSQ_FilterHandle * SQ_Filter
SQ_SetTransformation
SQ_ErrorCode SQ_SetTransformation(SQ_Filter hFilter, SQ_IntVector oVarNums, int iVarNums, SQ_WSTransformInfo oTransInfo)
SQ_CreateTimeSeriesFilter
SQ_ErrorCode SQ_CreateTimeSeriesFilter(SQ_Project hProject, SQ_TSFilterType eFilter, int iDatasetNumber, SQ_Filter *pFilterHandle)
SQ_GetAngle
SQ_ErrorCode SQ_GetAngle(SQ_Filter hFilter, float *pfAngle)
SQ_SetScale
SQ_ErrorCode SQ_SetScale(SQ_Filter hFilter, SQ_IntVector oVarNums, int iVarNums, SQ_FilterScalingType eScale)
SQ_RemoveFilterComponent
SQ_ErrorCode SQ_RemoveFilterComponent(SQ_Filter hFilter)
SQ_SetVarianceUsePadding
SQ_ErrorCode SQ_SetVarianceUsePadding(SQ_Filter hFilter, SQ_Bool bPadding)
SQ_GetDetailLevelNumOfIndexes
SQ_ErrorCode SQ_GetDetailLevelNumOfIndexes(SQ_Filter hFilter, int *pnIndexes)
tagSQ_IntVector
Definition: SQIntVector.h:27
SQ_SetSubModelPoints
SQ_ErrorCode SQ_SetSubModelPoints(SQ_Filter hFilter, int iSubModelPoints, SQ_Bool bDerivate)
SQ_GetRemainingSS
SQ_ErrorCode SQ_GetRemainingSS(SQ_Filter hFilter, float *pfRemainingSS)
SQ_SetDeltaX
SQ_ErrorCode SQ_SetDeltaX(SQ_Filter hFilter, float fDeltaX)
SQ_EWMAType
enum SQ_EWMATypeEnum SQ_EWMAType
SQ_FilterDetrendMode
enum SQ_FilterDetrendModeEnum SQ_FilterDetrendMode
SQ_TSFilterType
enum SQ_TSFilterTypeEnum SQ_TSFilterType
SQ_SetEnergyRetainedByDetailLevel
SQ_ErrorCode SQ_SetEnergyRetainedByDetailLevel(SQ_Filter hFilter)
SQProject.h
SQ_NextFilterComponent
SQ_ErrorCode SQ_NextFilterComponent(SQ_Filter hFilter)
SQ_SetDataset
SQ_ErrorCode SQ_SetDataset(SQ_Filter hFilter, int iDatasetNumber)
tagSQ_StringVector
Definition: SQStringVector.h:27
SQ_SetTargetVariable
SQ_ErrorCode SQ_SetTargetVariable(SQ_Filter hFilter, int iTargetVariable)
SQ_SetPluginFilterOptions
SQ_ErrorCode SQ_SetPluginFilterOptions(SQ_Filter hFilter, const char *szPluginName, const char *szOptions)
SQ_FilterType
enum SQ_FilterTypeEnum SQ_FilterType
SQ_SetLambdaValue
SQ_ErrorCode SQ_SetLambdaValue(SQ_Filter hFilter, float fLambda)
SQ_FinishFiltering
SQ_ErrorCode SQ_FinishFiltering(SQ_Filter hFilter)
SQ_ErrorCode
enum SQ_ErrorCodeEnum SQ_ErrorCode
SQ_SetDetailLevelDecimation
SQ_ErrorCode SQ_SetDetailLevelDecimation(SQ_Filter hFilter, int iDecNum)
SQ_SetData
SQ_ErrorCode SQ_SetData(SQ_Filter hFilter, SQ_IntVector *oXVarNums, SQ_IntVector *oYVarNums, SQ_IntVector *oObsNums)
SQ_FilterCompressionMethod
enum SQ_FilterCompressionMethodEnum SQ_FilterCompressionMethod
SQ_FilterDerivateOrder
enum SQ_FilterDerivateOrderEnum SQ_FilterDerivateOrder
SQ_FilterScalingType
enum SQ_FilterScalingTypeEnum SQ_FilterScalingType
SQ_SetChainOrderPlugin
SQ_ErrorCode SQ_SetChainOrderPlugin(SQ_Filter hFilter, const char *szPluginFilter)
SQ_GetDetailLevelTotalRetained
SQ_ErrorCode SQ_GetDetailLevelTotalRetained(SQ_Filter hFilter, float *pfRetained)
SQMDefines.h
SQ_GetPluginFilterNames
SQ_ErrorCode SQ_GetPluginFilterNames(SQ_StringVector *pvecNames)
SQ_SetWaveletFunction
SQ_ErrorCode SQ_SetWaveletFunction(SQ_Filter hFilter, SQ_FilterWaveletFunction eFunction, int iOrder)
SQ_SetPolynomialOrder
SQ_ErrorCode SQ_SetPolynomialOrder(SQ_Filter hFilter, SQ_FilterPolynomialOrder eOrder, SQ_Bool bDerivate)
SQErrorCodes.h
tagSQ_FilterHandle::reserved
void * reserved
Definition: SQMFilter.h:33
SQ_ReleaseFilterHandle
SQ_ErrorCode SQ_ReleaseFilterHandle(SQ_Filter hFilter)
SQ_SetDetrendMode
SQ_ErrorCode SQ_SetDetrendMode(SQ_Filter hFilter, SQ_FilterDetrendMode eMode)

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