F_VN_PredictSampleClass

F_VN_PredictSampleClass 1:

Classify a single sample.
Can use available TwinCAT Job Tasks for executing parallel code regions.

Syntax

Definition:

FUNCTION F_VN_PredictSampleClass : HRESULT
VAR_INPUT
    ipClassifier : ITcVnMlModel;
    ipSample     : ITcUnknown;
END_VAR
VAR_IN_OUT
    nClass       : DINT;
END_VAR
VAR_INPUT
    hrPrev       : HRESULT;
END_VAR

F_VN_PredictSampleClass 2: Inputs

Name

Type

Description

ipClassifier

ITcVnMlModel

Classifier to be used

ipSample

ITcUnknown

Container holding a single input sample (ContainerType_Vector_REAL or ContainerType_Vector_LREAL)

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_PredictSampleClass 3: In/Outputs

Name

Type

Description

nClass

DINT

Returns the classification result

F_VN_PredictSampleClass 4: Return value

HRESULT

Weiterführende Informationen

Die Funktion F_VN_PredictSampleClass klassifiziert ein Sample basierend auf einem Klassifikationsmodell.

Parameter

Klassifikationsmodell

Das zuvor trainierte Klassifikationsmodell muss an ipClassifier übergeben werden.

Sample

Die Samples werden in einem Container an ipSample übergeben. Der Typ des Containers muss entweder ContainerType_Vector_REAL oder ContainerType_Vector_LREAL sein.

Klasse

Als Klassifikationsergebnis wird die Klasse des Sample über nClass zurückgegeben.

Expert-Parameter

Die Expert-Variante F_VN_PredictSampleClassExp enthält zusätzliche Parameter.

Anwendung

Ein Sample kann z.B. so klassifiziert werden:

hr := F_VN_PredictSampleClass(
    ipClassifier    := ipMlModel,
    ipSample        := ipSample,
    nClass          := nClassResult,
    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