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

An EClassificationResult object represents the result of a classification. More...

#include <eVision/EasyDeepLearning/EasyClassify/EClassificationResult.h>

Collaboration diagram for eVision::EasyDeepLearning::EClassificationResult:

Public Member Functions

 EClassificationResult ()
 Constructs a non-valid EClassificationResult.
 EClassificationResult (const eVision::EasyDeepLearning::EClassificationResult &other)
 Copy constructor of an EClassificationResult object.
virtual ~EClassificationResult () throw ()
eVision::EasyDeepLearning::EClassificationResult & operator= (const eVision::EasyDeepLearning::EClassificationResult &other)
 Assignment operator.
bool IsValid () const
 Indicates whether the result was produced by EClassifier.
int GetBestLabelId () const
 Gets the most probable label id.
std::string GetBestLabel () const
 Gets the most probable label.
float GetBestProbability () const
 Gets the probability associated with the most probable label.
float GetProbability (const std::string &label) const
 Gets the probability corresponding to the given label.
int GetRanking (const std::string &label) const
 Gets the ranking corresponding to the given label. The ranking goes from 1 (most probable label) to EDeepLearningTool::GetNumLabels (least probable label).
int GetNumLabels () const
 Number of labels for which we have a probability or a ranking.
std::string GetLabel (int labelId) const
 Classification label. The labels are indexed from 0 to EClassificationResult::GetNumLabels.
eVision::ERGBColor GetLabelColor (int i) const
 Color of a label.
eVision::ERGBColor GetLabelColor (const std::string &label) const
 Color of a label.
bool HasGroundtruth () const
 Whether the result has a ground truth.
std::string GetGroundtruthLabel () const
 Ground truth label.
bool HasHeatmap () const
 Whether the result contains a heatmap.
eVision::EImageBW8 GetHeatmap () const
 Heatmap.
eVision::EImageC24 GetColorizedHeatmap (eVision::EasyDeepLearning::EHeatmapColormap colormap) const
 Colorized heatmap with no transparency.
eVision::EImageC24 GetColorizedHeatmap () const
 Colorized heatmap with no transparency.
eVision::EImageC24A GetColorizedHeatmapWithTransparency (float alpha, eVision::EasyDeepLearning::EHeatmapColormap colormap) const
 Colorized heatmap with transparency.
eVision::EImageC24A GetColorizedHeatmapWithTransparency (float alpha) const
 Colorized heatmap with transparency.
eVision::EImageC24A GetColorizedHeatmapWithTransparency () const
 Colorized heatmap with transparency.
eVision::EImageC24A GetColorizedHeatmapWithTransparency (float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap) const
 Colorized heatmap with transparency.
eVision::EImageC24A GetColorizedHeatmapWithTransparency (float minAlpha, float maxAlpha) const
 Colorized heatmap with transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float zoomX, float zoomY, float panX, float panY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float zoomX, float zoomY, float panX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float zoomX, float zoomY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float zoomX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX, float zoomY, float panX, float panY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX, float zoomY, float panX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX, float zoomY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (eVision::EDrawAdapter *graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float zoomX, float zoomY, float panX, float panY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float zoomX, float zoomY, float panX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float zoomX, float zoomY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float zoomX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX, float zoomY, float panX, float panY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX, float zoomY, float panX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX, float zoomY) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap, float zoomX) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
void DrawHeatmap (HDC graphicsContext, float minAlpha, float maxAlpha, eVision::EasyDeepLearning::EHeatmapColormap colormap) const
 Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.
bool HasOODScore () const
 Whether the result contains an OOD score.
bool IsOOD () const
 Whether the result is OOD.
float GetOODScore () const
 Get the OOD score.
float GetOODThreshold () const
 Get the OOD threshold.
void SetOODThreshold (float threshold)
 Set the OOD threshold.
 EClassificationResult (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

An EClassificationResult object represents the result of a classification.

The most probable label and its probability are accessible through the methods EClassificationResult::GetBestLabel and EClassificationResult::GetBestProbability. The probability and ranking of all labels are accessible through the EClassificationResult::GetProbability and EClassificationResult::GetRanking methods.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EClassificationResult() [1/3]

eVision::EasyDeepLearning::EClassificationResult::EClassificationResult ( )

Constructs a non-valid EClassificationResult.

◆ EClassificationResult() [2/3]

eVision::EasyDeepLearning::EClassificationResult::EClassificationResult ( const eVision::EasyDeepLearning::EClassificationResult & other)

Copy constructor of an EClassificationResult object.

Parameters
otherReference to the EClassificationResult object that should be copied

◆ ~EClassificationResult()

eVision::EasyDeepLearning::EClassificationResult::~EClassificationResult ( )
throw ( )
virtual

◆ EClassificationResult() [3/3]

eVision::EasyDeepLearning::EClassificationResult::EClassificationResult ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ DrawHeatmap() [1/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.

◆ DrawHeatmap() [2/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map

◆ DrawHeatmap() [3/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.

◆ DrawHeatmap() [4/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX,
float zoomY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.

◆ DrawHeatmap() [5/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX,
float zoomY,
float panX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawHeatmap() [6/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawHeatmap() [7/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float zoomX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.

◆ DrawHeatmap() [8/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float zoomX,
float zoomY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.

◆ DrawHeatmap() [9/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float zoomX,
float zoomY,
float panX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawHeatmap() [10/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( eVision::EDrawAdapter * graphicsContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawHeatmap() [11/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [12/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [13/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [14/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX,
float zoomY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [15/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX,
float zoomY,
float panX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [16/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [17/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float zoomX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [18/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float zoomX,
float zoomY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [19/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float zoomX,
float zoomY,
float panX ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawHeatmap() [20/20]

void eVision::EasyDeepLearning::EClassificationResult::DrawHeatmap ( HDC graphicsContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draw the heatmap. By default, the heatmap will be in the EHeatmapColormap::EHeatmapColormap_Jet colormap with a 0.5 transparency.

Parameters
graphicsContextHandle of the device context on which to draw.
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.
zoomYVertical zooming factor. A value greater than 1 means zoom in. If set to 0, the default value, the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ GetBestLabel()

std::string eVision::EasyDeepLearning::EClassificationResult::GetBestLabel ( ) const

Gets the most probable label.

◆ GetBestLabelId()

int eVision::EasyDeepLearning::EClassificationResult::GetBestLabelId ( ) const

Gets the most probable label id.

◆ GetBestProbability()

float eVision::EasyDeepLearning::EClassificationResult::GetBestProbability ( ) const

Gets the probability associated with the most probable label.

◆ GetColorizedHeatmap() [1/2]

eVision::EImageC24 eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmap ( ) const

Colorized heatmap with no transparency.

◆ GetColorizedHeatmap() [2/2]

eVision::EImageC24 eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmap ( eVision::EasyDeepLearning::EHeatmapColormap colormap) const

Colorized heatmap with no transparency.

Parameters
colormapColor map

◆ GetColorizedHeatmapWithTransparency() [1/5]

eVision::EImageC24A eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmapWithTransparency ( ) const

Colorized heatmap with transparency.

When a minimum and maximum alpha values are given, the transparency value for a pixel will depend on the value of the heatmap at that pixel. The range of heatmap values [0, 255] will be mapped to the range [minAlpha, maxAlpha].

◆ GetColorizedHeatmapWithTransparency() [2/5]

eVision::EImageC24A eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmapWithTransparency ( float alpha) const

Colorized heatmap with transparency.

When a minimum and maximum alpha values are given, the transparency value for a pixel will depend on the value of the heatmap at that pixel. The range of heatmap values [0, 255] will be mapped to the range [minAlpha, maxAlpha].

Parameters
alphaTransparency to apply everywhere

◆ GetColorizedHeatmapWithTransparency() [3/5]

eVision::EImageC24A eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmapWithTransparency ( float alpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap ) const

Colorized heatmap with transparency.

When a minimum and maximum alpha values are given, the transparency value for a pixel will depend on the value of the heatmap at that pixel. The range of heatmap values [0, 255] will be mapped to the range [minAlpha, maxAlpha].

Parameters
alphaTransparency to apply everywhere
colormapColor map

◆ GetColorizedHeatmapWithTransparency() [4/5]

eVision::EImageC24A eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmapWithTransparency ( float minAlpha,
float maxAlpha ) const

Colorized heatmap with transparency.

When a minimum and maximum alpha values are given, the transparency value for a pixel will depend on the value of the heatmap at that pixel. The range of heatmap values [0, 255] will be mapped to the range [minAlpha, maxAlpha].

Parameters
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.

◆ GetColorizedHeatmapWithTransparency() [5/5]

eVision::EImageC24A eVision::EasyDeepLearning::EClassificationResult::GetColorizedHeatmapWithTransparency ( float minAlpha,
float maxAlpha,
eVision::EasyDeepLearning::EHeatmapColormap colormap ) const

Colorized heatmap with transparency.

When a minimum and maximum alpha values are given, the transparency value for a pixel will depend on the value of the heatmap at that pixel. The range of heatmap values [0, 255] will be mapped to the range [minAlpha, maxAlpha].

Parameters
minAlphaMinimum transparency value.
maxAlphaMaximum transparency value.
colormapColor map

◆ GetGroundtruthLabel()

std::string eVision::EasyDeepLearning::EClassificationResult::GetGroundtruthLabel ( ) const

Ground truth label.

◆ GetHeatmap()

eVision::EImageBW8 eVision::EasyDeepLearning::EClassificationResult::GetHeatmap ( ) const

Heatmap.

◆ GetLabel()

std::string eVision::EasyDeepLearning::EClassificationResult::GetLabel ( int labelId) const

Classification label. The labels are indexed from 0 to EClassificationResult::GetNumLabels.

Parameters
labelIdId of the label

◆ GetLabelColor() [1/2]

eVision::ERGBColor eVision::EasyDeepLearning::EClassificationResult::GetLabelColor ( const std::string & label) const

Color of a label.

Parameters
labelLabel for which to get the color

The label color is controlled at the tool level. To change a color in a result, change the label color in the tool.

◆ GetLabelColor() [2/2]

eVision::ERGBColor eVision::EasyDeepLearning::EClassificationResult::GetLabelColor ( int i) const

Color of a label.

Parameters
iIndex of the label for which to get the color (between 0 and EClassificationResult::GetNumLabels - 1)

The label color is controlled at the tool level. To change a color in a result, change the label color in the tool.

◆ GetNumLabels()

int eVision::EasyDeepLearning::EClassificationResult::GetNumLabels ( ) const

Number of labels for which we have a probability or a ranking.

◆ GetOODScore()

float eVision::EasyDeepLearning::EClassificationResult::GetOODScore ( ) const

Get the OOD score.

◆ GetOODThreshold()

float eVision::EasyDeepLearning::EClassificationResult::GetOODThreshold ( ) const

Get the OOD threshold.

◆ GetProbability()

float eVision::EasyDeepLearning::EClassificationResult::GetProbability ( const std::string & label) const

Gets the probability corresponding to the given label.

Parameters
labelThe label

◆ GetRanking()

int eVision::EasyDeepLearning::EClassificationResult::GetRanking ( const std::string & label) const

Gets the ranking corresponding to the given label. The ranking goes from 1 (most probable label) to EDeepLearningTool::GetNumLabels (least probable label).

Parameters
labelThe label

◆ HasGroundtruth()

bool eVision::EasyDeepLearning::EClassificationResult::HasGroundtruth ( ) const

Whether the result has a ground truth.

◆ HasHeatmap()

bool eVision::EasyDeepLearning::EClassificationResult::HasHeatmap ( ) const

Whether the result contains a heatmap.

◆ HasOODScore()

bool eVision::EasyDeepLearning::EClassificationResult::HasOODScore ( ) const

Whether the result contains an OOD score.

◆ IsOOD()

bool eVision::EasyDeepLearning::EClassificationResult::IsOOD ( ) const

Whether the result is OOD.

◆ IsValid()

bool eVision::EasyDeepLearning::EClassificationResult::IsValid ( ) const

Indicates whether the result was produced by EClassifier.

A default constructed EClassificationResult is not valid.

◆ operator=()

eVision::EasyDeepLearning::EClassificationResult & eVision::EasyDeepLearning::EClassificationResult::operator= ( const eVision::EasyDeepLearning::EClassificationResult & other)

Assignment operator.

Parameters
otherReference to the EClassificationResult object used for the assignment

◆ SetOODThreshold()

void eVision::EasyDeepLearning::EClassificationResult::SetOODThreshold ( float threshold)

Set the OOD threshold.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyDeepLearning::EClassificationResult::wrappedClass_