eVision .NET API
Loading...
Searching...
No Matches
eVision.EHitAndMissKernel Class Reference

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

Inheritance diagram for eVision.EHitAndMissKernel:
Collaboration diagram for eVision.EHitAndMissKernel:

Public Member Functions

 EHitAndMissKernel (int startX, int startY, int endX, int endY)
 Constructs a EHitAndMissKernel object.
 EHitAndMissKernel (uint halfSizeX, uint halfSizeY)
 EHitAndMissKernel ()
 Constructs a EHitAndMissKernel object.
void SetSize (int startX, int startY, int endX, int endY)
 Modify the size of the kernel.
void SetSize (uint halfSizeX, uint halfSizeY)
 Modify the size 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)
 Returns the value of an element of the kernel at a given coordinate.

Properties

int StartX [get]
 Returns the abscissa of the leftmost element of the kernel.
int StartY [get]
 Returns the ordinate of the toptmost element of the kernel.
int EndX [get]
 Returns the abscissa of the rightmost element of the kernel.
int EndY [get]
 Returns the abscissa of the bottommost element of the kernel.

Detailed Description

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

License(s): None

Constructor & Destructor Documentation

◆ EHitAndMissKernel() [1/3]

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

Constructs a EHitAndMissKernel object.

Parameters
startXThe abscissa of the top leftmost element of the kernel. This value must be less than or equal to zero.
startYThe ordinate of the top leftmost element of the kernel. This value must be less than or equal to zero.
endXThe abscissa of the bottom rightmost element of the kernel. This value must be greater than or equal to zero.
endYThe 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/3]

eVision.EHitAndMissKernel.EHitAndMissKernel ( uint halfSizeX,
uint halfSizeY )
Parameters
halfSizeXThe half of the kernel width minus 1. This value must be greater than zero.
halfSizeYThe half of the kernel height minus 1. This value must be greater than zero.

◆ EHitAndMissKernel() [3/3]

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).

Member Function Documentation

◆ GetValue()

eVision.EHitAndMissValue eVision.EHitAndMissKernel.GetValue ( int x,
int y )

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

Parameters
xThe abscissa of the element.
yThe 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
startXThe abscissa of the top leftmost element of the kernel. This value must be less than or equal to zero.
startYThe ordinate of the top leftmost element of the kernel. This value must be less than or equal to zero.
endXThe abscissa of the bottom rightmost element of the kernel. This value must be greater than or equal to zero.
endYThe 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 ( uint halfSizeX,
uint halfSizeY )

Modify the size of the kernel.

Parameters
halfSizeXThe half of the kernel width minus 1. This value must be greater than zero.
halfSizeYThe 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
xThe abscissa of the element.
yThe ordinate of the element.
valueThe value of the element.

Property Documentation

◆ EndX

int eVision.EHitAndMissKernel.EndX
get

Returns the abscissa of the rightmost element of the kernel.

◆ EndY

int eVision.EHitAndMissKernel.EndY
get

Returns the abscissa of the bottommost element of the kernel.

◆ StartX

int eVision.EHitAndMissKernel.StartX
get

Returns the abscissa of the leftmost element of the kernel.

◆ StartY

int eVision.EHitAndMissKernel.StartY
get

Returns the ordinate of the toptmost element of the kernel.