F_VN_GetSampleClusterExp
Get the ID of the best-matching cluster of a single sample. (expert function)
Syntax
Definition:
FUNCTION F_VN_GetSampleClusterExp : HRESULT
VAR_INPUT
ipClusterer : ITcVnMlModel;
ipSample : ITcUnknown;
END_VAR
VAR_IN_OUT
nCluster : DINT;
END_VAR
VAR_INPUT
fNovelty : Reference To REAL;
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) | |
|
fNovelty |
Reference To REAL |
Returns the degree of novelty (0.0 if a sample is completely known; > 0.0 otherwise) of the presented sample (optional, set to 0 if not required) |
|
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 valueWeiterführende Informationen
Die Funktion F_VN_GetSampleClusterExp ist die Expert-Variante von F_VN_GetSampleCluster. Sie enthält zusätzliche Parameter.
Parameter
Clusterer-Modell
Für die Zuordnung zu Clustern muss ein zuvor trainiertes Modell an ipClusterer übergeben werden.
Sample
Ein Container mit einem Sample wird an ipSample übergeben. Der Typ des Containers muss ContainerType_Vector_REAL oder ContainerType_Vector_LREAL sein.
Cluster-ID
Die ermittelte ID wird über nCluster zurückgegeben.
Anomalie-Stärke
Die Anomalie-Stärke des Samples wird über die Referenz fNovelty zurückgegeben. Die Anomalie-Stärke gibt an, wie stark sich ein Sample von den Clustern unterscheidet. Eine Anomalie-Stärke von 0 gibt an, dass ein Sample dem Modell bekannt ist.
Anwendung
Die Berechnung des Clusters und der Anomalie-Stärke eines Sample kann so berechnet werden:
hr := F_VN_GetSampleClusterExp(
ipClusterer := ipClusterer,
ipSample := ipSample,
nCluster := nCluster,
fNovelty := fNovelty,
hrPrev := hr);
Verwandte Funktionen
Required License
TC3 Vision Machine Learning
System Requirements
Development environment | Target platform | PLC libraries to include |
|---|---|---|
TwinCAT V3.1.4024.54 or later | PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU | Tc3_Vision |