eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EasyDeepLearning::EROCPoint Struct Reference

The structure representing a point on the ROC (Receiver Operating Characteristic) curve. More...

#include <eVision/EasyDeepLearning/EDeepLearningDefectDetectionMetrics.h>

Public Member Functions

 EROCPoint ()
 Constructs a EROCPoint.
 EROCPoint (float threshold, int truePositiveCount, int positiveCount, int falsePositiveCount, int negativeCount)
 Constructs a EROCPoint.
void Load (const std::string &path)
 Loads the ROC point. The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Loads the ROC point. The given ESerializer must have been created for reading.
void Save (const std::string &path)
 Saves the ROC point. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Saves the ROC point. The given ESerializer must have been created for writing.

Public Attributes

float TPR
 The True Positive Rate: it is the number of defective images classified as defective, normalized by the number of defective images.
int TP
 The True Positive count: it is the number of defective images classified as defective.
int P
 The Positive count: it is the number of defective images.
float FPR
 The False Positive Rate: it is the number of good image classified as defective, normalized by the number of good images.
int FP
 The False Positive count: it is the number of good image classified as defective.
int N
 The Negative count: it is the number of good images.
float Threshold
 The threshold associated with the true and false positive rates (see EUnsupervisedSegmenter::SetClassificationThreshold).

Detailed Description

The structure representing a point on the ROC (Receiver Operating Characteristic) curve.

License(s): None

Constructor & Destructor Documentation

◆ EROCPoint() [1/2]

eVision::EasyDeepLearning::EROCPoint::EROCPoint ( )

Constructs a EROCPoint.

◆ EROCPoint() [2/2]

eVision::EasyDeepLearning::EROCPoint::EROCPoint ( float threshold,
int truePositiveCount,
int positiveCount,
int falsePositiveCount,
int negativeCount )

Constructs a EROCPoint.

Parameters
thresholdThreshold corresponding to the ROC point.
truePositiveCountNumber of defective images classified as defective.
positiveCountTotal number of defective images.
falsePositiveCountNumber of good images classified as defective.
negativeCountTotal number of good images.

Member Function Documentation

◆ Load() [1/2]

void eVision::EasyDeepLearning::EROCPoint::Load ( const std::string & path)

Loads the ROC point. The given ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Load() [2/2]

void eVision::EasyDeepLearning::EROCPoint::Load ( eVision::ESerializer * serializer)

Loads the ROC point. The given ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ Save() [1/2]

void eVision::EasyDeepLearning::EROCPoint::Save ( const std::string & path)

Saves the ROC point. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [2/2]

void eVision::EasyDeepLearning::EROCPoint::Save ( eVision::ESerializer * serializer)

Saves the ROC point. The given ESerializer must have been created for writing.

Parameters
serializerThe serializer.

Member Data Documentation

◆ FP

int eVision::EasyDeepLearning::EROCPoint::FP

The False Positive count: it is the number of good image classified as defective.

◆ FPR

float eVision::EasyDeepLearning::EROCPoint::FPR

The False Positive Rate: it is the number of good image classified as defective, normalized by the number of good images.

◆ N

int eVision::EasyDeepLearning::EROCPoint::N

The Negative count: it is the number of good images.

◆ P

int eVision::EasyDeepLearning::EROCPoint::P

The Positive count: it is the number of defective images.

◆ Threshold

float eVision::EasyDeepLearning::EROCPoint::Threshold

The threshold associated with the true and false positive rates (see EUnsupervisedSegmenter::SetClassificationThreshold).

◆ TP

int eVision::EasyDeepLearning::EROCPoint::TP

The True Positive count: it is the number of defective images classified as defective.

◆ TPR

float eVision::EasyDeepLearning::EROCPoint::TPR

The True Positive Rate: it is the number of defective images classified as defective, normalized by the number of defective images.

The TPR can be NaN (Not A Number) if the metrics were computed using only good images.