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

Segments an image using a pixel-by-pixel single threshold given as an image. More...

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

Inheritance diagram for eVision::Segmenters::EReferenceImageSegmenter:
Collaboration diagram for eVision::Segmenters::EReferenceImageSegmenter:

Public Member Functions

virtual ~EReferenceImageSegmenter () throw ()
bool operator== (const eVision::Segmenters::EReferenceImageSegmenter &other) const
 Comparison operator.
void Load (const std::string &path)
 Load the EReferenceImageSegmenter configuration. The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Load the EReferenceImageSegmenter configuration. The given ESerializer must have been created for reading.
void Save (const std::string &path)
 Save the EReferenceImageSegmenter configuration. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Save the EReferenceImageSegmenter 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 void SetBlackLayerEncoded (bool encode)
 Black layer encoding status.
virtual void SetWhiteLayerIndex (unsigned int index)
 Index of the white layer in the destination coded image.
virtual void SetWhiteLayerEncoded (bool encode)
 White layer encoding status.
void SetReferenceImageBW8 (const eVision::EROIBW8 *image)
 Reference image for the segmentation of EROIBW8 images.
const eVision::EROIBW8 * GetReferenceImageBW8 () const
 Reference image for the segmentation of EROIBW8 images.
void SetReferenceImageBW16 (const eVision::EROIBW16 *image)
 Reference image for the segmentation of EROIBW16 images.
const eVision::EROIBW16 * GetReferenceImageBW16 () const
 Reference image for the segmentation of EROIBW16 images.
void SetReferenceImageC24 (const eVision::EROIC24 *image)
 Reference image for the segmentation of EROIC24 images.
const eVision::EROIC24 * GetReferenceImageC24 () const
 Reference image for the segmentation of EROIC24 images.
 EReferenceImageSegmenter (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 unsigned int GetBlackLayerIndex () const
 Index of the black layer in the destination coded image.
virtual bool GetBlackLayerEncoded () const
 Black layer encoding status.
virtual unsigned int GetWhiteLayerIndex () const
 Index of the white layer in the destination coded image.
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 pixel-by-pixel single threshold given as an image.

This segmenter is applicable to EROIBW8, EROIBW16 and EROIC24 images. It produces coded images with two layers. The threshold is defined for each pixel individually by means of a reference image of the same type as the source image.

For grayscale images, the White layer (usually, with index 1) contains unmasked pixels having a gray value in a range defined by the gray value of the respective pixel in the reference image and the white color.

For RGB color images, the White layer (usually, with index 1) contains unmasked pixels having a color inside the cube of the RGB color space defined by the color of the respective pixel in the reference image and the white color (255,255,255).

The Black layer (usually, with index 0) contains the remaining unmasked pixels.

License(s): EasyObject

Constructor & Destructor Documentation

◆ ~EReferenceImageSegmenter()

eVision::Segmenters::EReferenceImageSegmenter::~EReferenceImageSegmenter ( )
throw ( )
virtual

◆ EReferenceImageSegmenter()

eVision::Segmenters::EReferenceImageSegmenter::EReferenceImageSegmenter ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetReferenceImageBW16()

const eVision::EROIBW16 * eVision::Segmenters::EReferenceImageSegmenter::GetReferenceImageBW16 ( ) const

Reference image for the segmentation of EROIBW16 images.

Note that the image is copied internally.

◆ GetReferenceImageBW8()

const eVision::EROIBW8 * eVision::Segmenters::EReferenceImageSegmenter::GetReferenceImageBW8 ( ) const

Reference image for the segmentation of EROIBW8 images.

Note that the image is copied internally.

◆ GetReferenceImageC24()

const eVision::EROIC24 * eVision::Segmenters::EReferenceImageSegmenter::GetReferenceImageC24 ( ) const

Reference image for the segmentation of EROIC24 images.

Note that the image is copied internally.

◆ Load() [1/2]

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

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

Parameters
pathThe file path.

◆ Load() [2/2]

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

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

Parameters
serializerThe serializer.

◆ operator==()

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

Comparison operator.

Parameters
otherOther segmenter to compare to.

◆ Save() [1/2]

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

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

Parameters
pathThe file path.

◆ Save() [2/2]

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

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

Parameters
serializerThe serializer.

◆ SetBlackLayerEncoded()

void eVision::Segmenters::EReferenceImageSegmenter::SetBlackLayerEncoded ( bool encode)
virtual

Black layer encoding status.

Reimplemented from eVision::Segmenters::ETwoLayersImageSegmenter.

◆ SetBlackLayerIndex()

void eVision::Segmenters::EReferenceImageSegmenter::SetBlackLayerIndex ( unsigned int index)
virtual

Index of the black layer in the destination coded image.

Setting this property automatically switches on the encoding of the black layer.

Reimplemented from eVision::Segmenters::ETwoLayersImageSegmenter.

◆ SetReferenceImageBW16()

void eVision::Segmenters::EReferenceImageSegmenter::SetReferenceImageBW16 ( const eVision::EROIBW16 * image)

Reference image for the segmentation of EROIBW16 images.

Note that the image is copied internally.

◆ SetReferenceImageBW8()

void eVision::Segmenters::EReferenceImageSegmenter::SetReferenceImageBW8 ( const eVision::EROIBW8 * image)

Reference image for the segmentation of EROIBW8 images.

Note that the image is copied internally.

◆ SetReferenceImageC24()

void eVision::Segmenters::EReferenceImageSegmenter::SetReferenceImageC24 ( const eVision::EROIC24 * image)

Reference image for the segmentation of EROIC24 images.

Note that the image is copied internally.

◆ SetWhiteLayerEncoded()

void eVision::Segmenters::EReferenceImageSegmenter::SetWhiteLayerEncoded ( bool encode)
virtual

White layer encoding status.

Reimplemented from eVision::Segmenters::ETwoLayersImageSegmenter.

◆ SetWhiteLayerIndex()

void eVision::Segmenters::EReferenceImageSegmenter::SetWhiteLayerIndex ( unsigned int index)
virtual

Index of the white layer in the destination coded image.

Setting this property automatically switches on the encoding of the white layer.

Reimplemented from eVision::Segmenters::ETwoLayersImageSegmenter.