eVision::Segmenters::EThreeLayersImageSegmenter Class Reference

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

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

Inheritance diagram for eVision::Segmenters::EThreeLayersImageSegmenter:

Collaboration diagram for eVision::Segmenters::EThreeLayersImageSegmenter:

Public Member Functions
virtual	~EThreeLayersImageSegmenter () throw ()
bool	operator== (const eVision::Segmenters::EThreeLayersImageSegmenter &other) const
	Comparison operator.
void	Load (const std::string &path)
	Load the EThreeLayersImageSegmenter configuration. The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer)
	Load the EThreeLayersImageSegmenter configuration. The given ESerializer must have been created for reading.
void	Save (const std::string &path)
	Save the EThreeLayersImageSegmenter configuration. The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer)
	Save the EThreeLayersImageSegmenter 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	SetNeutralLayerIndex (unsigned int index)
	Index of the neutral layer in the destination coded image.
virtual unsigned int	GetNeutralLayerIndex () const
	Index of the neutral layer in the destination coded image.
virtual void	SetNeutralLayerEncoded (bool encode)
	Neutral layer encoding status.
virtual bool	GetNeutralLayerEncoded () const
	Neutral 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.
	EThreeLayersImageSegmenter (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 three 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

~EThreeLayersImageSegmenter()

eVision::Segmenters::EThreeLayersImageSegmenter::~EThreeLayersImageSegmenter ( ) throw (  )

virtual

EThreeLayersImageSegmenter()

eVision::Segmenters::EThreeLayersImageSegmenter::EThreeLayersImageSegmenter

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetBlackLayerEncoded()

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

virtual

Black layer encoding status.

GetBlackLayerIndex()

unsigned int eVision::Segmenters::EThreeLayersImageSegmenter::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.

GetNeutralLayerEncoded()

bool eVision::Segmenters::EThreeLayersImageSegmenter::GetNeutralLayerEncoded ( ) const

virtual

Neutral layer encoding status.

GetNeutralLayerIndex()

unsigned int eVision::Segmenters::EThreeLayersImageSegmenter::GetNeutralLayerIndex ( ) const

virtual

Index of the neutral layer in the destination coded image.

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

GetWhiteLayerEncoded()

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

virtual

White layer encoding status.

GetWhiteLayerIndex()

unsigned int eVision::Segmenters::EThreeLayersImageSegmenter::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::EThreeLayersImageSegmenter::Load

(

const std::string &

path

)

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

Parameters

path	The file path.

Load() [2/2]

void eVision::Segmenters::EThreeLayersImageSegmenter::Load

(

eVision::ESerializer *

serializer

)

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

Parameters

serializer

The serializer.

operator==()

bool eVision::Segmenters::EThreeLayersImageSegmenter::operator==

(

const eVision::Segmenters::EThreeLayersImageSegmenter &

other

)

const

Comparison operator.

Parameters

other

Other segmenter to compare to.

Save() [1/2]

void eVision::Segmenters::EThreeLayersImageSegmenter::Save

(

const std::string &

path

)

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

Parameters

path	The file path.

Save() [2/2]

void eVision::Segmenters::EThreeLayersImageSegmenter::Save

(

eVision::ESerializer *

serializer

)

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

Parameters

serializer

The serializer.

SetBlackLayerEncoded()

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

virtual

Black layer encoding status.

Parameters

encode

A Boolean indicating whether or not the layer is to be encoded.

SetBlackLayerIndex()

void eVision::Segmenters::EThreeLayersImageSegmenter::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.

SetNeutralLayerEncoded()

void eVision::Segmenters::EThreeLayersImageSegmenter::SetNeutralLayerEncoded ( bool encode )

virtual

Neutral layer encoding status.

SetNeutralLayerIndex()

void eVision::Segmenters::EThreeLayersImageSegmenter::SetNeutralLayerIndex ( unsigned int index )

virtual

Index of the neutral layer in the destination coded image.

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

SetWhiteLayerEncoded()

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

virtual

White layer encoding status.

SetWhiteLayerIndex()

void eVision::Segmenters::EThreeLayersImageSegmenter::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.