F_VN_PredictSampleClass

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

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.)

In/Outputs

Name	Type	Description
nClass	DINT	Returns the classification result

Return value

HRESULT

Further information

The function F_VN_PredictSampleClass classifies a sample based on a classification model.

Parameter

Classification model

The previously trained classification model must be transferred to ipClassifier.

Sample

The samples are transferred to ipSample in a container. The container type must be either ContainerType_Vector_REAL or ContainerType_Vector_LREAL.

Class

The class of the sample is returned as the classification result via nClass.

Expert parameters

The expert variant F_VN_PredictSampleClassExp contains additional parameters.

Application

For example, a sample can be classified as follows:

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

Related functions

F_VN_PredictBatch

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