F_VN_PredictSampleScalarExp

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

Syntax

Definition:

FUNCTION F_VN_PredictSampleScalarExp : HRESULT
VAR_INPUT
    ipRegressor : ITcVnMlModel;
    ipSample    : ITcUnknown;
END_VAR
VAR_IN_OUT
    fPrediction : REAL;
END_VAR
VAR_INPUT
    fNovelty    : Reference To  REAL;
    hrPrev      : HRESULT;
END_VAR

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)
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
fPrediction	REAL	Returns the predicted output

Return value

HRESULT

Weiterführende Informationen

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

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.

Anomalie-Stärke

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

Anwendung

Der Regressionswert eines Samples kann z.B. so berechnet werden:

hr := F_VN_PredictSampleScalarExp(
    ipRegressor := ipRegressor,
    ipSample    := ipSample,
    fPrediction := fPrediction,
    fNovelty    := fNovelty,
    hrPrev      := hr);

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