eVision::EHitAndMissKernel Class Reference

Class that defines a kernel for the morphological hit-and-miss operations. More...

#include <eVision/EasyImage/EHitAndMissKernel.h>

Collaboration diagram for eVision::EHitAndMissKernel:

Public Member Functions
	EHitAndMissKernel (int startX, int startY, int endX, int endY)
	Constructs a EHitAndMissKernel object.
	EHitAndMissKernel (unsigned int halfSizeX, unsigned int halfSizeY)
	EHitAndMissKernel ()
	Constructs a EHitAndMissKernel object.
virtual	~EHitAndMissKernel () throw ()
void	SetSize (int startX, int startY, int endX, int endY)
	Modify the size of the kernel.
void	SetSize (unsigned int halfSizeX, unsigned int halfSizeY)
	Modify the size of the kernel.
int	GetStartX () const
	Returns the abscissa of the leftmost element of the kernel.
int	GetStartY () const
	Returns the ordinate of the toptmost element of the kernel.
int	GetEndX () const
	Returns the abscissa of the rightmost element of the kernel.
int	GetEndY () const
	Returns the abscissa of the bottommost element of the kernel.
void	SetValue (int x, int y, eVision::EHitAndMissValue value)
	Sets the value of an element of the kernel at a given coordinate.
eVision::EHitAndMissValue	GetValue (int x, int y) const
	Returns the value of an element of the kernel at a given coordinate.
	EHitAndMissKernel (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Class that defines a kernel for the morphological hit-and-miss operations.

License(s): None

Constructor & Destructor Documentation

EHitAndMissKernel() [1/4]

eVision::EHitAndMissKernel::EHitAndMissKernel	(	int	startX,
		int	startY,
		int	endX,
		int	endY )

Constructs a EHitAndMissKernel object.

Parameters

startX	The abscissa of the top leftmost element of the kernel. This value must be less than or equal to zero.
startY	The ordinate of the top leftmost element of the kernel. This value must be less than or equal to zero.
endX	The abscissa of the bottom rightmost element of the kernel. This value must be greater than or equal to zero.
endY	The ordinate of the bottom rightmost element of the kernel. This value must be greater than or equal to zero.

The constructor without argument creates a centered kernel of size 3x3.

All the elements of the kernel are initialized with EHitAndMissValue::EHitAndMissValue_DontCare values.

If the object is constructed by specifying the halves of the kernel dimensions, the width (resp. the height) of the kernel is given by 2 * halfSizeX + 1 (resp. 2 * halfSizeY + 1). Otherwise, the width (resp. the height) of the kernel is given by endX - startX + 1 (resp. endY - startY + 1).

EHitAndMissKernel() [2/4]

eVision::EHitAndMissKernel::EHitAndMissKernel	(	unsigned int	halfSizeX,
		unsigned int	halfSizeY )

Parameters

halfSizeX	The half of the kernel width minus 1. This value must be greater than zero.
halfSizeY	The half of the kernel height minus 1. This value must be greater than zero.

EHitAndMissKernel() [3/4]

eVision::EHitAndMissKernel::EHitAndMissKernel

(

)

Constructs a EHitAndMissKernel object.

The constructor without argument creates a centered kernel of size 3x3.

All the elements of the kernel are initialized with EHitAndMissValue::EHitAndMissValue_DontCare values.

If the object is constructed by specifying the halves of the kernel dimensions, the width (resp. the height) of the kernel is given by 2 * halfSizeX + 1 (resp. 2 * halfSizeY + 1). Otherwise, the width (resp. the height) of the kernel is given by endX - startX + 1 (resp. endY - startY + 1).

~EHitAndMissKernel()

eVision::EHitAndMissKernel::~EHitAndMissKernel ( ) throw (  )

virtual

EHitAndMissKernel() [4/4]

eVision::EHitAndMissKernel::EHitAndMissKernel

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetEndX()

int eVision::EHitAndMissKernel::GetEndX

(

)

const

Returns the abscissa of the rightmost element of the kernel.

GetEndY()

int eVision::EHitAndMissKernel::GetEndY

(

)

const

Returns the abscissa of the bottommost element of the kernel.

GetStartX()

int eVision::EHitAndMissKernel::GetStartX

(

)

const

Returns the abscissa of the leftmost element of the kernel.

GetStartY()

int eVision::EHitAndMissKernel::GetStartY

(

)

const

Returns the ordinate of the toptmost element of the kernel.

GetValue()

eVision::EHitAndMissValue eVision::EHitAndMissKernel::GetValue	(	int	x,
		int	y ) const

Returns the value of an element of the kernel at a given coordinate.

Parameters

x	The abscissa of the element.
y	The ordinate of the element.

SetSize() [1/2]

void eVision::EHitAndMissKernel::SetSize	(	int	startX,
		int	startY,
		int	endX,
		int	endY )

Modify the size of the kernel.

Parameters

startX	The abscissa of the top leftmost element of the kernel. This value must be less than or equal to zero.
startY	The ordinate of the top leftmost element of the kernel. This value must be less than or equal to zero.
endX	The abscissa of the bottom rightmost element of the kernel. This value must be greater than or equal to zero.
endY	The ordinate of the bottom rightmost element of the kernel. This value must be greater than or equal to zero.

All the elements of the kernel are initialized with EHitAndMissValue::EHitAndMissValue_DontCare values.

If the object is constructed by specifying the halves of the kernel dimensions, the width (resp. the height) of the kernel is given by 2 * halfSizeX + 1 (resp. 2 * halfSizeY + 1). Otherwise, the width (resp. the height) of the kernel is given by endX - startX + 1 (resp. endY - startY + 1).

SetSize() [2/2]

void eVision::EHitAndMissKernel::SetSize	(	unsigned int	halfSizeX,
		unsigned int	halfSizeY )

Modify the size of the kernel.

Parameters

halfSizeX	The half of the kernel width minus 1. This value must be greater than zero.
halfSizeY	The half of the kernel height minus 1. This value must be greater than zero.

All the elements of the kernel are initialized with EHitAndMissValue::EHitAndMissValue_DontCare values.

If the object is constructed by specifying the halves of the kernel dimensions, the width (resp. the height) of the kernel is given by 2 * halfSizeX + 1 (resp. 2 * halfSizeY + 1). Otherwise, the width (resp. the height) of the kernel is given by endX - startX + 1 (resp. endY - startY + 1).

SetValue()

void eVision::EHitAndMissKernel::SetValue	(	int	x,
		int	y,
		eVision::EHitAndMissValue	value )

Sets the value of an element of the kernel at a given coordinate.

Parameters

x	The abscissa of the element.
y	The ordinate of the element.
value	The value of the element.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EHitAndMissKernel::wrappedClass_