F_VN_GetSampleCluster
Get the ID of the best-matching cluster of a single sample.
Syntax
Definition:
FUNCTION F_VN_GetSampleCluster : HRESULT
VAR_INPUT
ipClusterer : ITcVnMlModel;
ipSample : ITcUnknown;
END_VAR
VAR_IN_OUT
nCluster : DINT;
END_VAR
VAR_INPUT
hrPrev : HRESULT;
END_VAR
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipClusterer |
Clusterer to be used | |
|
ipSample |
Container holding a single input sample (ContainerType_Vector_REAL or ContainerType_Vector_LREAL) | |
|
hrPrev |
HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) |
In/Outputs
|
Name |
Type |
Description |
|---|---|---|
|
nCluster |
DINT |
Returns the ID of the cluster the sample has been assigned to |
Return valueFurther information
The function F_VN_GetSampleCluster determines the best matching cluster for a sample and returns its ID.
Parameter
Clusterer model
A previously trained model must be transferred to ipClusterer for assignment to clusters.
Sample
A container with a sample is transferred to ipSample. The type of container must be ContainerType_Vector_REAL or ContainerType_Vector_LREAL.
Cluster ID
The ID determined is returned via nCluster.
Expert parameters
The expert variant F_VN_GetSampleClusterExp contains additional parameters.
Application
The assignment of a sample to a cluster can be calculated as follows:
hr := F_VN_GetSampleCluster(
ipClusterer := ipClusterer,
ipSample := ipSample,
nCluster := nCluster,
hrPrev := hr);Related functions
Required License
TC3 Machine Learning Realtime Inference
System Requirements
Development environment | Target platform | PLC libraries to include |
|---|---|---|
TwinCAT V3.1.4024.59 or later | PC or CX (x64) with min. PL50, e.g. Intel 4-core Atom CPU | Tc3_Vision |