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

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

Public Member Functions

None __init__ (self, int startX, int startY, int endX, int endY)
 Constructs a eVision.EHitAndMissKernel object.
None __init__ (self, int halfSizeX, int halfSizeY)
None __init__ (self)
 Constructs a eVision.EHitAndMissKernel object.
None SetSize (self, int startX, int startY, int endX, int endY)
 Modify the size of the kernel.
None SetSize (self, int halfSizeX, int halfSizeY)
 Modify the size of the kernel.
None SetValue (self, int x, int y, eVision.EHitAndMissValue value)
 Sets the value of an element of the kernel at a given coordinate.
eVision.EHitAndMissValue GetValue (self, int x, int y)
 Returns the value of an element of the kernel at a given coordinate.
int StartX (self)
 Returns the abscissa of the leftmost element of the kernel.
int StartY (self)
 Returns the ordinate of the toptmost element of the kernel.
int EndX (self)
 Returns the abscissa of the rightmost element of the kernel.
int EndY (self)
 Returns the abscissa of the bottommost element of the kernel.

Detailed Description

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

Remarks:

License(s): None

Constructor & Destructor Documentation

◆ __init__() [1/3]

None eVision.EHitAndMissKernel.__init__ ( self,
int startX,
int startY,
int endX,
int endY )

Constructs a eVision.EHitAndMissKernel object.

Remarks:

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

All the elements of the kernel are initialized with eVision.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).

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.

◆ __init__() [2/3]

None eVision.EHitAndMissKernel.__init__ ( self,
int halfSizeX,
int 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.

◆ __init__() [3/3]

None eVision.EHitAndMissKernel.__init__ ( self)

Constructs a eVision.EHitAndMissKernel object.

Remarks:

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

All the elements of the kernel are initialized with eVision.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

◆ EndX()

int eVision.EHitAndMissKernel.EndX ( self)

Returns the abscissa of the rightmost element of the kernel.

◆ EndY()

int eVision.EHitAndMissKernel.EndY ( self)

Returns the abscissa of the bottommost element of the kernel.

◆ GetValue()

eVision.EHitAndMissValue eVision.EHitAndMissKernel.GetValue ( self,
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]

None eVision.EHitAndMissKernel.SetSize ( self,
int halfSizeX,
int halfSizeY )

Modify the size of the kernel.

Remarks:

All the elements of the kernel are initialized with eVision.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).

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.

◆ SetSize() [2/2]

None eVision.EHitAndMissKernel.SetSize ( self,
int startX,
int startY,
int endX,
int endY )

Modify the size of the kernel.

Remarks:

All the elements of the kernel are initialized with eVision.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).

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.

◆ SetValue()

None eVision.EHitAndMissKernel.SetValue ( self,
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.

◆ StartX()

int eVision.EHitAndMissKernel.StartX ( self)

Returns the abscissa of the leftmost element of the kernel.

◆ StartY()

int eVision.EHitAndMissKernel.StartY ( self)

Returns the ordinate of the toptmost element of the kernel.