F_VN_PredictSampleClassExp

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

Syntax

Definition:

FUNCTION F_VN_PredictSampleClassExp : HRESULT
VAR_INPUT
    ipClassifier : ITcVnMlModel;
    ipSample     : ITcUnknown;
END_VAR
VAR_IN_OUT
    nClass       : DINT;
END_VAR
VAR_INPUT
    fNovelty     : Reference To  REAL;
    hrPrev       : HRESULT;
END_VAR

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)
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	HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

In/Outputs

Name	Type	Description
nClass	DINT	Returns the classification result

Return value

HRESULT

Weiterführende Informationen

Die Funktion F_VN_PredictSampleClassExp ist die Expert-Variante von F_VN_PredictSampleClass. Sie enthält zusätzliche Parameter.

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.

Anomalie-Stärke

Die Anomalie-Stärke des Samples wird über fNovelty zurückgegeben.

Anwendung

Ein Sample kann z.B. so klassifiziert werden:

hr := F_VN_PredictSampleClassExp(
    ipClassifier    := ipMlModel,
    ipSample        := ipSample,
    nClass          := nClassResult,
    fNovelty        := fNovelty,
    hrPrev          := hr);

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