F_VN_PredictSampleVector

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

Syntax

Definition:

FUNCTION F_VN_PredictSampleVector : HRESULT
VAR_INPUT
    ipRegressor  : ITcVnMlModel;
    ipSample     : ITcUnknown;
    ipPrediction : Reference To  ITcVnContainer;
    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)
ipPrediction	Reference To ITcVnContainer	Returns the predicted output (ContainerType_Vector_REAL or ContainerType_Vector_LREAL, depending on ipSample)
hrPrev	HRESULT	HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

Return value

HRESULT

Weiterführende Informationen

Die Funktion F_VN_PredictSampleVector berechnet den Prädiktionsvektor 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ädiktionsvektor wird über die Referenz ipPrediction als Container zurückgegeben. Der Container-Typ wird von ipSamples übernommen.

Expert-Parameter

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

Anwendung

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

hr := F_VN_PredictSampleVector(
    ipRegressor := ipRegressor,
    ipSample    := ipSample,
    ipPrediction:= ipPrediction,
    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