F_VN_PredictSampleScalar

F_VN_PredictSampleScalar 1:

Compute a scalar prediction for a single sample.
Can use available TwinCAT Job Tasks for executing parallel code regions.

Syntax

Definition:

FUNCTION F_VN_PredictSampleScalar : HRESULT
VAR_INPUT
    ipRegressor : ITcVnMlModel;
    ipSample    : ITcUnknown;
END_VAR
VAR_IN_OUT
    fPrediction : REAL;
END_VAR
VAR_INPUT
    hrPrev      : HRESULT;
END_VAR

F_VN_PredictSampleScalar 2: Inputs

Name

Type

Description

ipRegressor

ITcVnMlModel

Regressor 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_PredictSampleScalar 3: In/Outputs

Name

Type

Description

fPrediction

REAL

Returns the predicted output

F_VN_PredictSampleScalar 4: Return value

HRESULT

Weiterführende Informationen

Die Funktion F_VN_PredictSampleScalar berechnet den skalaren Prädiktionswert eines Samples basierend auf einem Regressionsmodell.

Parameter

Regressionsmodell

Das zuvor trainierte Regressionsmodell muss an ipRegressor übergeben werden.

Sample

Der Sample-Container wird als ipSample übergeben. Der Typ des Containers muss entweder ContainerType_Vector_REAL oder ContainerType_Vector_LREAL sein.

Prädiktion

Der berechnete Prädiktionswert wird über fPrediction zurückgegeben.

Expert-Parameter

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

Anwendung

Der Prädiktionswert eines Samples kann z.B. so berechnet werden:

hr := F_VN_PredictSampleScalar(
    ipRegressor := ipRegressor,
    ipSample    := ipSample,
    fPrediction := fPrediction,
    hrPrev      := hr);

Verwandte Funktionen

Required License

TC3 Vision Machine Learning

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1. 4024.44 or later

PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU

Tc3_Vision