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

An EUnsupervisedSegmenterResult object represents the result of a EUnsupervisedSegmenter tool. More...

#include <eVision/EasyDeepLearning/EasySegment/EUnsupervisedSegmenterResult.h>

Collaboration diagram for eVision::EasyDeepLearning::EUnsupervisedSegmenterResult:

Public Member Functions

 EUnsupervisedSegmenterResult ()
 Constructs a non-valid EUnsupervisedSegmenterResult.
 EUnsupervisedSegmenterResult (const eVision::EasyDeepLearning::EUnsupervisedSegmenterResult &other)
 Copy constructor of an EUnsupervisedSegmenterResult object.
virtual ~EUnsupervisedSegmenterResult () throw ()
eVision::EasyDeepLearning::EUnsupervisedSegmenterResult & operator= (const eVision::EasyDeepLearning::EUnsupervisedSegmenterResult &other)
 Assignment operator.
bool IsComplete () const
 Indicates whether the result is complete and ready to be used.
bool IsValid () const
 Indicates whether the result was produced by a EUnsupervisedSegmenter object.
bool IsDefective () const
 Indicates whether the result is defective/not good based on the threshold of the unsupervised segmentation tool that produced the result (see EUnsupervisedSegmenter::SetClassificationThreshold).
bool IsGood () const
 Indicates whether the result is good based on the threshold of the unsupervised segmentation tool that produced the result (see EUnsupervisedSegmenter::SetClassificationThreshold).
float GetClassificationScore () const
 Score that is used for classification of the image.
float GetError () const
 Error of the image.
eVision::EImageBW8 GetSegmentationMap () const
 Returns the segmentation map. The segmentation map is a grayscale image where all defective pixels have a value strictly higher than 0. The value of a pixel is proportional to the importance of the defect at that position.
eVision::ERegion GetRegion () const
 Returns the segmented region. The segmented region corresponds to the pixels that have a value strictly higher than 0 in the segmentation map (see EUnsupervisedSegmenterResult::GetSegmentationMap).
void Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws the segmentation (with transparency).
void Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX)
 Draws the segmentation (with transparency).
void Draw (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY)
 Draws the segmentation (with transparency).
void Draw (eVision::EDrawAdapter *drawAdapter, float zoomX)
 Draws the segmentation (with transparency).
void Draw (eVision::EDrawAdapter *drawAdapter)
 Draws the segmentation (with transparency).
void Draw (HDC graphicsContext, float zoomX, float zoomY, float panX, float panY)
 Draws the segmentation (with transparency).
void Draw (HDC graphicsContext, float zoomX, float zoomY, float panX)
 Draws the segmentation (with transparency).
void Draw (HDC graphicsContext, float zoomX, float zoomY)
 Draws the segmentation (with transparency).
void Draw (HDC graphicsContext, float zoomX)
 Draws the segmentation (with transparency).
void Draw (HDC graphicsContext)
 Draws the segmentation (with transparency).
 EUnsupervisedSegmenterResult (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

An EUnsupervisedSegmenterResult object represents the result of a EUnsupervisedSegmenter tool.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EUnsupervisedSegmenterResult() [1/3]

eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::EUnsupervisedSegmenterResult ( )

Constructs a non-valid EUnsupervisedSegmenterResult.

◆ EUnsupervisedSegmenterResult() [2/3]

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

Copy constructor of an EUnsupervisedSegmenterResult object.

Parameters
otherReference to the EUnsupervisedSegmenterResult object that should be copied

◆ ~EUnsupervisedSegmenterResult()

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

◆ EUnsupervisedSegmenterResult() [3/3]

eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::EUnsupervisedSegmenterResult ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Draw() [1/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( eVision::EDrawAdapter * drawAdapter)

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).

◆ Draw() [2/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( eVision::EDrawAdapter * drawAdapter,
float zoomX )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).
zoomXHorizontal zooming factor. A value greater than 1 means zoom in. By default, true scale is used.

◆ Draw() [3/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( eVision::EDrawAdapter * drawAdapter,
float zoomX,
float zoomY )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).
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, so as to provide isotropic zooming.

◆ Draw() [4/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( eVision::EDrawAdapter * drawAdapter,
float zoomX,
float zoomY,
float panX )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).
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, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [5/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( eVision::EDrawAdapter * drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).
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, so as 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.

◆ Draw() [6/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( HDC graphicsContext)

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

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.

◆ Draw() [7/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( HDC graphicsContext,
float zoomX )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

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.

◆ Draw() [8/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( HDC graphicsContext,
float zoomX,
float zoomY )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

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, so as 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.

◆ Draw() [9/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( HDC graphicsContext,
float zoomX,
float zoomY,
float panX )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

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, so as 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.

◆ Draw() [10/10]

void eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::Draw ( HDC graphicsContext,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the segmentation (with transparency).

To indicate the importance of the defect at a given pixel, the segmentation is drawn using a gradient going from yellow (least important) to red (maximum importance) (See EUnsupervisedSegmenterResult::GetSegmentationMap).

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, so as 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.

◆ GetClassificationScore()

float eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::GetClassificationScore ( ) const

Score that is used for classification of the image.

The classification score is the value which is compared to the classification threshold of the EUnsupervisedSegmenter to decide whether the corresponding image is good or defective.

◆ GetError()

float eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::GetError ( ) const

Error of the image.

The error is the quantity that is minimized on good images during training.

◆ GetRegion()

eVision::ERegion eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::GetRegion ( ) const

Returns the segmented region. The segmented region corresponds to the pixels that have a value strictly higher than 0 in the segmentation map (see EUnsupervisedSegmenterResult::GetSegmentationMap).

◆ GetSegmentationMap()

eVision::EImageBW8 eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::GetSegmentationMap ( ) const

Returns the segmentation map. The segmentation map is a grayscale image where all defective pixels have a value strictly higher than 0. The value of a pixel is proportional to the importance of the defect at that position.

◆ IsComplete()

bool eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::IsComplete ( ) const

Indicates whether the result is complete and ready to be used.

◆ IsDefective()

bool eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::IsDefective ( ) const

Indicates whether the result is defective/not good based on the threshold of the unsupervised segmentation tool that produced the result (see EUnsupervisedSegmenter::SetClassificationThreshold).

◆ IsGood()

bool eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::IsGood ( ) const

Indicates whether the result is good based on the threshold of the unsupervised segmentation tool that produced the result (see EUnsupervisedSegmenter::SetClassificationThreshold).

◆ IsValid()

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

Indicates whether the result was produced by a EUnsupervisedSegmenter object.

A default constructed EUnsupervisedSegmenterResult is not valid.

◆ operator=()

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

Assignment operator.

Parameters
otherReference to the EUnsupervisedSegmenterResult object used for the assignment

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyDeepLearning::EUnsupervisedSegmenterResult::wrappedClass_