F_VN_GetSampleNovelty

F_VN_GetSampleNovelty 1:

Get the degree of novelty of a single sample.
Can use available TwinCAT Job Tasks for executing parallel code regions.

Syntax

Definition:

FUNCTION F_VN_GetSampleNovelty : HRESULT
VAR_INPUT
    ipNoveltyDetector : ITcVnMlModel;
    ipSample          : ITcUnknown;
END_VAR
VAR_IN_OUT
    fNovelty          : REAL;
END_VAR
VAR_INPUT
    hrPrev            : HRESULT;
END_VAR

F_VN_GetSampleNovelty 2: Inputs

Name

Type

Description

ipNoveltyDetector

ITcVnMlModel

Novelty detector 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_GetSampleNovelty 3: In/Outputs

Name

Type

Description

fNovelty

REAL

Returns the degree of novelty (0.0 if a sample is completely known; > 0.0 otherwise) of the presented sample

F_VN_GetSampleNovelty 4: Return value

HRESULT

Weiterführende Informationen

Die Funktion F_VN_GetSampleNovelty ermittelt für ein Samples in einem Container die Anomalie-Stärke.

Parameter

Anomalie-Modell

Für die Berechnung der Anomalie-Stärke muss das zuvor trainierte Modell an ipNoveltyDetector übergeben werden.

Sample

Ein Container mit einem Sample wird an ipSample übergeben

Anomalie-Stärke

Die Anomalie-Stärke wird über die Referenz fNovelty zurückgegeben. Die Anomalie-Stärke gibt an, wie stark sich ein Sample von den gelernten Daten unterscheidet. Eine Anomalie-Stärke von 0 gibt an, dass ein Sample dem Modell bekannt ist.

Anwendung

Die Anomalie-Stärke eines Samples kann so berechnet werden:

hr := F_VN_GetSampleNovelty(
    ipNoveltyDetector   := ipNoveltyDetector,
    ipSample            := ipSample,
    fNovelty            := fNovelty,
    hrPrev              := hr);

Verwandte Funktionen

Required License

TC3 Vision Machine Learning

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1.4024.54 or later

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

Tc3_Vision