F_VN_GetClusterNum
Get the number of clusters used by this clusterer.
Syntax
Definition:
FUNCTION F_VN_GetClusterNum : HRESULT
VAR_INPUT
ipClusterer : ITcVnMlModel;
END_VAR
VAR_IN_OUT
nClusterNum : ULINT;
END_VAR
VAR_INPUT
hrPrev : HRESULT;
END_VAR
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipClusterer |
Clusterer to be used | |
|
hrPrev |
HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) |
In/Outputs
|
Name |
Type |
Description |
|---|---|---|
|
nClusterNum |
ULINT |
Returns the number of clusters |
Further information
The function F_VN_GetClusterNum returns the number of clusters in a Clusterer model.
Parameter
Clusterer model
The previously trained Clusterer model must be transferred to ipClusterer.
Number of clusters
The number of clusters is returned via nClusterNum.
Application
For example, the number of clusters can be determined as follows:
hr := F_VN_GetClusterNum(
ipClusterer := ipClusterer,
nClusterNum := nClusterNum,
hrPrev := hr);Related functions
Required License
TC3 Machine Learning Realtime Inference
Return value