F_VN_TrainSampleCluster

F_VN_TrainSampleCluster 1:

Train a clusterer with a single sample and return the ID of the cluster the sample has been assigned to, if requested. The clusterer must be online trainable.

Syntax

Definition:

FUNCTION F_VN_TrainSampleCluster : HRESULT
VAR_INPUT
    ipClusterer : ITcVnMlModel;
    ipSample    : ITcUnknown;
    nCluster    : Reference To  DINT;
    hrPrev      : HRESULT;
END_VAR

F_VN_TrainSampleCluster 2: Inputs

Name

Type

Description

ipClusterer

ITcVnMlModel

Clusterer to be used

ipSample

ITcUnknown

Container holding a single input sample (ContainerType_Vector_REAL or ContainerType_Vector_LREAL)

nCluster

Reference To DINT

Returns the ID of the cluster the sample has been assigned to (If the pointer is 0, no cluster ID is requested.)

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_TrainSampleCluster 3: Return value

HRESULT

Further information

The function F_VN_TrainSampleCluster trains a clusterer model with a sample and returns the corresponding cluster ID of the sample.

Parameter

Clusterer model

The previously created Clusterer model must be transferred to ipClusterer.

Sample

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

Cluster

The cluster ID associated with the sample is returned via nCluster.

Application

For example, a Clusterer model can be trained with a single sample as follows:

hr := F_VN_TrainSampleCluster(
    := ipClusterModel,
    ipSample        := ipSample,
    nCluster        := nCluster,
    hrPrev          := hr);

Related functions

Required License

TC3 Machine Learning Realtime Inference

System Requirements