eVision::Segmenters::ETwoLayersImageSegmenter Class Reference

The base class from which all the segmenters that produce two layers derive. More...

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

Inheritance diagram for eVision::Segmenters::ETwoLayersImageSegmenter:

Collaboration diagram for eVision::Segmenters::ETwoLayersImageSegmenter:

Public Member Functions
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

The base class from which all the segmenters that produce two layers derive.

The Layer Encoding can be enabled/disabled for each layer individually. The index of the layers in the coded image can also be assigned individually.

License(s): EasyObject

Constructor & Destructor Documentation

~ETwoLayersImageSegmenter()

eVision::Segmenters::ETwoLayersImageSegmenter::~ETwoLayersImageSegmenter ( ) throw (  )

virtual

ETwoLayersImageSegmenter()

eVision::Segmenters::ETwoLayersImageSegmenter::ETwoLayersImageSegmenter

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetBlackLayerEncoded()

bool eVision::Segmenters::ETwoLayersImageSegmenter::GetBlackLayerEncoded ( ) const

virtual

Black layer encoding status.

GetBlackLayerIndex()

unsigned int eVision::Segmenters::ETwoLayersImageSegmenter::GetBlackLayerIndex ( ) const

virtual

Index of the black layer in the destination coded image.

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

GetWhiteLayerEncoded()

bool eVision::Segmenters::ETwoLayersImageSegmenter::GetWhiteLayerEncoded ( ) const

virtual

White layer encoding status.

GetWhiteLayerIndex()

unsigned int eVision::Segmenters::ETwoLayersImageSegmenter::GetWhiteLayerIndex ( ) const

virtual

Index of the white layer in the destination coded image.

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

Load() [1/2]

void eVision::Segmenters::ETwoLayersImageSegmenter::Load

(

const std::string &

path

)

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

Parameters

path	The file path.

Load() [2/2]

void eVision::Segmenters::ETwoLayersImageSegmenter::Load

(

eVision::ESerializer *

serializer

)

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

Parameters

serializer

The serializer.

operator==()

bool eVision::Segmenters::ETwoLayersImageSegmenter::operator==

(

const eVision::Segmenters::ETwoLayersImageSegmenter &

other

)

const

Comparison operator.

Parameters

other

The other ETwoLayersImageSegmenter that will be compared with this one.

Save() [1/2]

void eVision::Segmenters::ETwoLayersImageSegmenter::Save

(

const std::string &

path

)

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

Parameters

path	The file path.

Save() [2/2]

void eVision::Segmenters::ETwoLayersImageSegmenter::Save

(

eVision::ESerializer *

serializer

)

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

Parameters

serializer

The serializer.

SetBlackLayerEncoded()

void eVision::Segmenters::ETwoLayersImageSegmenter::SetBlackLayerEncoded ( bool encode )

virtual

Black layer encoding status.

Reimplemented in eVision::Segmenters::EImageRangeSegmenter, and eVision::Segmenters::EReferenceImageSegmenter.

SetBlackLayerIndex()

void eVision::Segmenters::ETwoLayersImageSegmenter::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 in eVision::Segmenters::EImageRangeSegmenter, and eVision::Segmenters::EReferenceImageSegmenter.

SetWhiteLayerEncoded()

void eVision::Segmenters::ETwoLayersImageSegmenter::SetWhiteLayerEncoded ( bool encode )

virtual

White layer encoding status.

Reimplemented in eVision::Segmenters::EImageRangeSegmenter, and eVision::Segmenters::EReferenceImageSegmenter.

SetWhiteLayerIndex()

void eVision::Segmenters::ETwoLayersImageSegmenter::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 in eVision::Segmenters::EImageRangeSegmenter, and eVision::Segmenters::EReferenceImageSegmenter.