Segments an image using a single threshold on a grayscale image. More...

#include <eVision/EasyObject/EasyObject2/Segmenters/EGrayscaleSingleThresholdSegmenter.h>

Inheritance diagram for eVision::Segmenters::EGrayscaleSingleThresholdSegmenter:

Collaboration diagram for eVision::Segmenters::EGrayscaleSingleThresholdSegmenter:

Public Member Functions
virtual	~EGrayscaleSingleThresholdSegmenter () throw ()
bool	operator== (const eVision::Segmenters::EGrayscaleSingleThresholdSegmenter &other) const
	Comparison operator.
void	Load (const std::string &path)
	Load the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer)
	Load the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for reading.
void	Save (const std::string &path)
	Save the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer)
	Save the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for writing.
void	SetMode (eVision::EGrayscaleSingleThreshold mode)
	Threshold selection mode.
eVision::EGrayscaleSingleThreshold	GetMode () const
	Threshold selection mode.
void	SetAbsoluteThreshold (unsigned int threshold)
	Value of the threshold to be used in the case of absolute thresholding.
unsigned int	GetAbsoluteThreshold () const
	Value of the threshold to be used in the case of absolute thresholding.
void	SetRelativeThreshold (float threshold)
	Fraction of the image pixels that belongs to the black layer in the case of relative thresholding.
float	GetRelativeThreshold () const
	Fraction of the image pixels that belongs to the black layer in the case of relative thresholding.
unsigned int	GetLastThreshold () const
	Retrieves the actual threshold value that was used for the last image that got encoded by the segmenter.
bool	IsFirstApplication () const
	Checks whether the segmenter has already been used to segment an image.
	EGrayscaleSingleThresholdSegmenter (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::Segmenters::ETwoLayersImageSegmenter
virtual	~ETwoLayersImageSegmenter () throw ()
bool	operator== (const eVision::Segmenters::ETwoLayersImageSegmenter &other) const
	Comparison operator.
void	Load (const std::string &path)
	Load the ETwoLayersImageSegmenter configuration. The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer)
	Load the ETwoLayersImageSegmenter configuration. The given ESerializer must have been created for reading.
void	Save (const std::string &path)
	Save the ETwoLayersImageSegmenter configuration. The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer)
	Save the ETwoLayersImageSegmenter configuration. The given ESerializer must have been created for writing.
virtual void	SetBlackLayerIndex (unsigned int index)
	Index of the black layer in the destination coded image.
virtual unsigned int	GetBlackLayerIndex () const
	Index of the black layer in the destination coded image.
virtual void	SetBlackLayerEncoded (bool encode)
	Black layer encoding status.
virtual bool	GetBlackLayerEncoded () const
	Black layer encoding status.
virtual void	SetWhiteLayerIndex (unsigned int index)
	Index of the white layer in the destination coded image.
virtual unsigned int	GetWhiteLayerIndex () const
	Index of the white layer in the destination coded image.
virtual void	SetWhiteLayerEncoded (bool encode)
	White layer encoding status.
virtual bool	GetWhiteLayerEncoded () const
	White layer encoding status.
	ETwoLayersImageSegmenter (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::Segmenters::EImageSegmenter
virtual	~EImageSegmenter () throw ()
	EImageSegmenter (CppWrapperInternal::InternalConstructor)

Additional Inherited Members
Public Attributes inherited from eVision::Segmenters::EImageSegmenter
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Segments an image using a single threshold on a grayscale image.

This segmenter is applicable to EROIBW8 and EROIBW16 grayscale images. It produces coded images with two layers: the black layer (usually, with index 0) contains the unmasked pixels having a gray value strictly below the threshold value; and the white layer (usually, with index 1) contains the remaining unmasked pixels, i.e. unmasked pixels having a gray value greater or equal to the threshold value. The default thresholding method is minimum residue. If another method is required, the EGrayscaleSingleThresholdSegmenter::SetMode property must be set prior to encoding.

License(s): EasyObject

Constructor & Destructor Documentation

◆ ~EGrayscaleSingleThresholdSegmenter()

eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::~EGrayscaleSingleThresholdSegmenter	(		)
throw	(	)

virtual

◆ EGrayscaleSingleThresholdSegmenter()

eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::EGrayscaleSingleThresholdSegmenter ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetAbsoluteThreshold()

unsigned int eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::GetAbsoluteThreshold ( ) const

Value of the threshold to be used in the case of absolute thresholding.

◆ GetLastThreshold()

unsigned int eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::GetLastThreshold ( ) const

Retrieves the actual threshold value that was used for the last image that got encoded by the segmenter.

A call to this method will result in an exception if it is the first time the segmenter is applied. To check whether the segmenter has already been applied, call the EGrayscaleSingleThresholdSegmenter::IsFirstApplication method.

◆ GetMode()

eVision::EGrayscaleSingleThreshold eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::GetMode ( ) const

Threshold selection mode.

◆ GetRelativeThreshold()

float eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::GetRelativeThreshold ( ) const

Fraction of the image pixels that belongs to the black layer in the case of relative thresholding.

◆ IsFirstApplication()

bool eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::IsFirstApplication ( ) const

Checks whether the segmenter has already been used to segment an image.

◆ Load() [1/2]

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::Load ( const std::string & path )

Load the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for reading.

Parameters

path	The file path.

◆ Load() [2/2]

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::Load ( eVision::ESerializer * serializer )

Load the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for reading.

Parameters

serializer The serializer.

◆ operator==()

bool eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::operator== ( const eVision::Segmenters::EGrayscaleSingleThresholdSegmenter & other ) const

Comparison operator.

Parameters

other Other segmenter to compare to.

◆ Save() [1/2]

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::Save ( const std::string & path )

Save the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for writing.

Parameters

path	The file path.

◆ Save() [2/2]

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::Save ( eVision::ESerializer * serializer )

Save the EGrayscaleSingleThresholdSegmenter configuration. The given ESerializer must have been created for writing.

Parameters

serializer The serializer.

◆ SetAbsoluteThreshold()

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::SetAbsoluteThreshold ( unsigned int threshold )

Value of the threshold to be used in the case of absolute thresholding.

◆ SetMode()

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::SetMode ( eVision::EGrayscaleSingleThreshold mode )

Threshold selection mode.

◆ SetRelativeThreshold()

void eVision::Segmenters::EGrayscaleSingleThresholdSegmenter::SetRelativeThreshold ( float threshold )

Fraction of the image pixels that belongs to the black layer in the case of relative thresholding.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~EGrayscaleSingleThresholdSegmenter()

◆ EGrayscaleSingleThresholdSegmenter()

Member Function Documentation

◆ GetAbsoluteThreshold()

◆ GetLastThreshold()

◆ GetMode()

◆ GetRelativeThreshold()

◆ IsFirstApplication()

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator==()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetAbsoluteThreshold()

◆ SetMode()

◆ SetRelativeThreshold()