F_VN_PredictSampleScalar

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

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

In/Outputs

Name	Type	Description
fPrediction	REAL	Returns the predicted output

Return value

HRESULT

Further information

The function F_VN_PredictSampleScalar calculates the scalar prediction value of a sample based on a regression model.

Parameter

Regression model

The previously trained regression model must be transferred to ipRegressor.

Sample

The sample container is transferred as ipSample. The container type must be either ContainerType_Vector_REAL or ContainerType_Vector_LREAL.

Prediction

The calculated prediction value is returned via fPrediction.

Expert parameters

The expert variant F_VN_PredictSampleScalarExp contains additional parameters.

Application

For example, the prediction value of a sample can be calculated as follows:

hr := F_VN_PredictSampleScalar(
    ipRegressor := ipRegressor,
    ipSample    := ipSample,
    fPrediction := fPrediction,
    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