eVision.EPatternFinder Class Reference

Manages a complete finding context in EasyFind. More...

Inheritance diagram for eVision.EPatternFinder:

Collaboration diagram for eVision.EPatternFinder:

Public Member Functions
	EPatternFinder ()
	Constructs a EPatternFinder.EPatternFinder context.
	EPatternFinder (eVision.EPatternFinder other)
	Constructs a EPatternFinder.EPatternFinder context.
void	Learn (eVision.EROIBW8 pattern)
	Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.
void	Learn (eVision.EROIBW8 pattern, eVision.ERegion region)
	Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.
void	Learn (eVision.EROIBW8 pattern, eVision.ERegion region, eVision.EFrame frame)
	Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.
void	Learn (eVision.EROIBW8 pattern, eVision.EFrame frame)
	Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.
void	Learn (eVision.EVectorModel model)
	Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.
void	Learn (eVision.EROIBW8 pattern, eVision.EROIBW8 dontCare)
	Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.
void	LearnPatterns (eVision.EROIBW8[] patterns)
	Learns multiple (at least two) patterns.
void	LearnPatterns (eVision.EROIBW8[] patterns, eVision.ERegion[] regions)
	Learns multiple (at least two) patterns.
void	LearnPatterns (eVision.EROIBW8[] patterns, eVision.ERegion[] regions, eVision.EFrame frame)
	Learns multiple (at least two) patterns.
void	LearnPatterns (eVision.EROIBW8[] patterns, eVision.EFrame frame)
	Learns multiple (at least two) patterns.
void	CopyLearntPattern (eVision.EImageBW8 image, bool maskWithDontCare, uint learntPatternIndex)
	Copies the learned pattern in the supplied image. If no pattern has been learned, an exception with code EError.EError_NoPatternLearnt will be thrown.
void	CopyLearntPattern (eVision.EImageBW8 image, bool maskWithDontCare)
	Copies the learned pattern in the supplied image. If no pattern has been learned, an exception with code EError.EError_NoPatternLearnt will be thrown.
void	CopyLearntPattern (eVision.EImageBW8 image)
	Copies the learned pattern in the supplied image. If no pattern has been learned, an exception with code EError.EError_NoPatternLearnt will be thrown.
eVision.EFoundPattern[]	Find (eVision.EROIBW8 source)
	Locates a set of possible occurrences of the learned pattern in the supplied search field.
eVision.EFoundPattern[]	Find (eVision.EROIBW8 source, eVision.ERegion region)
	Locates a set of possible occurrences of the learned pattern in the supplied search field.
eVision.EFoundPattern[]	Find (eVision.EROIBW8 source, eVision.ERegion region, eVision.EFrame frame)
	Locates a set of possible occurrences of the learned pattern in the supplied search field.
eVision.EFoundPattern[]	Find (eVision.EROIBW8 source, eVision.EFrame frame)
	Locates a set of possible occurrences of the learned pattern in the supplied search field.
void	DrawModel (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, uint learntPatternIndex, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, uint learntPatternIndex, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, uint learntPatternIndex, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, uint learntPatternIndex, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (eVision.EDrawAdapter graphicContext, uint learntPatternIndex)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, eVision.ERGBColor color, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, eVision.ERGBColor color, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (IntPtr graphicContext, eVision.ERGBColor color)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModelWithCurrentPen (IntPtr graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModelWithCurrentPen (IntPtr graphicContext, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModelWithCurrentPen (IntPtr graphicContext, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModelWithCurrentPen (IntPtr graphicContext, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModelWithCurrentPen (IntPtr graphicContext)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
eVision.EFindFeaturePoint[]	GetFeaturePoints (uint learntPatternIndex)
	The feature points used by the model.
void	Save (string path)
	Loads an EPatternFinder.The given EPatternFinder must have been created for writing.
void	Save (eVision.ESerializer serializer)
	Loads an EPatternFinder.The given EPatternFinder must have been created for writing.
void	Load (string path)
	Loads an EPatternFinder.The given EPatternFinder must have been created for reading.
void	Load (eVision.ESerializer serializer)
	Loads an EPatternFinder.The given EPatternFinder must have been created for reading.
void	DrawModel (System.Drawing.Graphics graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX, float zoomY)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.
void	DrawModel (System.Drawing.Graphics graphicContext, eVision.ERGBColor color)
	Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Properties
uint	NumLearnedPatterns [get]
	Indicates the number of patterns learnt. 0 is returned if no learning was performed.
bool	LearningDone [get]
	Indicates whether a pattern has already been learned.
bool	LearningHasRegion [get]
	Indicates whether a ERegion was used alongside the learned pattern. Returns false if no learning was performed.
float	AngleBias [get, set]
	Angle bias, expressed in the current angle unit.
float	AngleTolerance [get, set]
	Angle tolerance, expressed in the current angle unit.
float	ScaleBias [get, set]
	Scale bias, expressed in units (not in percent).
float	MaxOverlap [get, set]
	Overlapping tolerance.
float	MaximumOverlapping [get, set]
float	ScaleTolerance [get, set]
	Scale tolerance, expressed in units (not in percent).
bool	Interpolate [get, set]
	Whether interpolation is performed when searching for a pattern occurrence.
bool	ComputePerFeaturePointScore [get, set]
	Whether the EPatternFinder should compute a score for each feature point. The scores are then displayed as a Red-Yellow-Green colormap by EFoundPattern.Draw. Note that the scores correspond to the Point-By-Point variants of EPatternFinder.ContrastMode, so if EPatternFinder.ContrastMode is not a Point-By-Point variant, EFoundPattern.Score isn't exactly the average of the displayed scores for each feature point.
eVision.EFindContrastMode	ContrastMode [get, set]
	Contrast of the instance, as defined in EFindContrastMode.
eVision.EReductionMode	ReductionMode [get, set]
	The reduction mode that is to be used when learning the model (automatic or manual), as defined in EReductionMode.
eVision.ELocalSearchMode	LocalSearchMode [get, set]
	Sets the local search mode.
int	AngleSearchExtent [get, set]
	The angular extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.
int	ScaleSearchExtent [get, set]
	The scaling extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.
int	XSearchExtent [get, set]
	The X-axis extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.
int	YSearchExtent [get, set]
	The Y-axis extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.
uint	MaxInstances [get, set]
	Maximum number of instances to be found.
uint	MaxInitialCandidates [get, set]
	Maximum number of initial candidates.
float	MinScore [get, set]
	Minimum score of found instances, between [-1.0, 1.0].
float	ReductionStrength [get, set]
	The reduction strength that is to be used when learning the model, between 0 and 1.
uint	MinFeaturePoints [get, set]
	Minimum number of feature points at the coarse stage.
uint	MaxFeaturePoints [get, set]
	Maximum number of feature points at the fine stage.
eVision.EPatternType	PatternType [get, set]
	Pattern type, as defined in EPatternType.
int	FindExtension [get, set]
	Extension value, that is the pattern margin size (in pixels) that is allowed to go out of the search field.
float	LightBalance [get, set]
	Light balance, between [-1.0, 1.0].
eVision.EThinStructureMode	ThinStructureMode [get, set]
	Mode for EPatternType.EPatternType_ThinStructure, as defined in EThinStructureMode.
eVision.EFindFeaturePoint[]	FeaturePoints [get]
	The feature points used by the model.
eVision.EPoint	Pivot [get, set]
	Reference point in the model.
ulong	LearnTimeOut [get, set]
	Time-out for the EPatternFinder.Learn and EPatternFinder.LearnPatterns methods.
ulong	FindTimeOut [get, set]
	Time-out for the EPatternFinder.Find method.

Detailed Description

Manages a complete finding context in EasyFind.

License(s): EasyFind

Constructor & Destructor Documentation

EPatternFinder() [1/2]

eVision.EPatternFinder.EPatternFinder

(

)

Constructs a EPatternFinder.EPatternFinder context.

All properties are initialized to their respective default values.

EPatternFinder() [2/2]

eVision.EPatternFinder.EPatternFinder

(

eVision.EPatternFinder

other

)

Constructs a EPatternFinder.EPatternFinder context.

Parameters

other

Another EPatternFinder object to be copied in the new EPatternFinder object.

All properties are initialized to their respective default values.

Member Function Documentation

CopyLearntPattern() [1/3]

void eVision.EPatternFinder.CopyLearntPattern

(

eVision.EImageBW8

image

)

Copies the learned pattern in the supplied image. If no pattern has been learned, an exception with code EError.EError_NoPatternLearnt will be thrown.

Parameters

image

Pointer to the image in which the learned pattern will be returned.

CopyLearntPattern() [2/3]

void eVision.EPatternFinder.CopyLearntPattern	(	eVision.EImageBW8	image,
		bool	maskWithDontCare )

Copies the learned pattern in the supplied image. If no pattern has been learned, an exception with code EError.EError_NoPatternLearnt will be thrown.

Parameters

image	Pointer to the image in which the learned pattern will be returned.
maskWithDontCare	If true and a don't care Area or Region was used when learning, masked pixels will be displayed in black. Default: false.

CopyLearntPattern() [3/3]

void eVision.EPatternFinder.CopyLearntPattern	(	eVision.EImageBW8	image,
		bool	maskWithDontCare,
		uint	learntPatternIndex )

Copies the learned pattern in the supplied image. If no pattern has been learned, an exception with code EError.EError_NoPatternLearnt will be thrown.

Parameters

image	Pointer to the image in which the learned pattern will be returned.
maskWithDontCare	If true and a don't care Area or Region was used when learning, masked pixels will be displayed in black. Default: false.
learntPatternIndex	Index of the learnt pattern. Default: 0.

DrawModel() [1/30]

void eVision.EPatternFinder.DrawModel

(

eVision.EDrawAdapter

graphicContext

)

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext

Handle to the device context of the destination windows.

DrawModel() [2/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.

DrawModel() [3/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

DrawModel() [4/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

DrawModel() [5/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

DrawModel() [6/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		uint	learntPatternIndex )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
learntPatternIndex	Index of the learnt pattern. Defaults to 0.

DrawModel() [7/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		uint	learntPatternIndex,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
learntPatternIndex	Index of the learnt pattern. Defaults to 0.
zoomX	Horizontal zooming factor.

DrawModel() [8/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		uint	learntPatternIndex,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
learntPatternIndex	Index of the learnt pattern. Defaults to 0.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

DrawModel() [9/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		uint	learntPatternIndex,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
learntPatternIndex	Index of the learnt pattern. Defaults to 0.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

DrawModel() [10/30]

void eVision.EPatternFinder.DrawModel	(	eVision.EDrawAdapter	graphicContext,
		uint	learntPatternIndex,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
learntPatternIndex	Index of the learnt pattern. Defaults to 0.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

DrawModel() [11/30]

void eVision.EPatternFinder.DrawModel

(

IntPtr

graphicContext

)

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext

Handle to the device context of the destination windows.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [12/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		eVision.ERGBColor	color )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [13/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [14/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [15/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [16/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [17/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [18/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [19/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [20/30]

void eVision.EPatternFinder.DrawModel	(	IntPtr	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [21/30]

void eVision.EPatternFinder.DrawModel

(

System.Drawing.Graphics

graphicContext

)

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext

Handle to the device context of the destination windows.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [22/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [23/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [24/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [25/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [26/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [27/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [28/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [29/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModel() [30/30]

void eVision.EPatternFinder.DrawModel	(	System.Drawing.Graphics	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModelWithCurrentPen() [1/5]

void eVision.EPatternFinder.DrawModelWithCurrentPen

(

IntPtr

graphicContext

)

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext

Handle to the device context of the destination windows.

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModelWithCurrentPen() [2/5]

void eVision.EPatternFinder.DrawModelWithCurrentPen	(	IntPtr	graphicContext,
		float	zoomX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModelWithCurrentPen() [3/5]

void eVision.EPatternFinder.DrawModelWithCurrentPen	(	IntPtr	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModelWithCurrentPen() [4/5]

void eVision.EPatternFinder.DrawModelWithCurrentPen	(	IntPtr	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

DrawModelWithCurrentPen() [5/5]

void eVision.EPatternFinder.DrawModelWithCurrentPen	(	IntPtr	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the model features with an overlay in image coordinates. Image coordinates means that we expect to draw in the parent image of the roi given in EPatternFinder.Learn or EPatternFinder.LearnPatterns.

Parameters

graphicContext	Handle to the device context of the destination windows.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Find() [1/4]

eVision.EFoundPattern[] eVision.EPatternFinder.Find

(

eVision.EROIBW8

source

)

Locates a set of possible occurrences of the learned pattern in the supplied search field.

Parameters

source

Image or part of an image in which the learned model has to be searched for.

This method will fail if no pattern has been learned previously. The result is a vector of EFoundPattern objects.

Find() [2/4]

eVision.EFoundPattern[] eVision.EPatternFinder.Find	(	eVision.EROIBW8	source,
		eVision.EFrame	frame )

Locates a set of possible occurrences of the learned pattern in the supplied search field.

Parameters

source	Image or part of an image in which the learned model has to be searched for.
frame	Frame of the input image.

This method will fail if no pattern has been learned previously. The result is a vector of EFoundPattern objects.

Find() [3/4]

eVision.EFoundPattern[] eVision.EPatternFinder.Find	(	eVision.EROIBW8	source,
		eVision.ERegion	region )

Locates a set of possible occurrences of the learned pattern in the supplied search field.

Parameters

source	Image or part of an image in which the learned model has to be searched for.
region	Region into the ROI where the search is performed.

This method will fail if no pattern has been learned previously. The result is a vector of EFoundPattern objects.

Find() [4/4]

eVision.EFoundPattern[] eVision.EPatternFinder.Find	(	eVision.EROIBW8	source,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Locates a set of possible occurrences of the learned pattern in the supplied search field.

Parameters

source	Image or part of an image in which the learned model has to be searched for.
region	Region into the ROI where the search is performed.
frame	Frame of the input image.

This method will fail if no pattern has been learned previously. The result is a vector of EFoundPattern objects.

GetFeaturePoints()

eVision.EFindFeaturePoint[] eVision.EPatternFinder.GetFeaturePoints

(

uint

learntPatternIndex

)

The feature points used by the model.

Parameters

learntPatternIndex

Index of the learnt pattern.

The feature points are expressed with respect to the parent image of the ROI given as input to the EPatternFinder.LearnPatterns method.

Learn() [1/6]

void eVision.EPatternFinder.Learn

(

eVision.EROIBW8

pattern

)

Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.

Parameters

pattern

Model to be learned (ROI).

Learning another pattern erases the information stored for the first one. A "don't care area" can be set as argument, allowing to mask and not take into account certain parts of the pattern while learning. The "don't care area" mask should have the same size as the pattern or as its eventual parent image. The mask should be a bi-level image with pixel - values of '0' for ignored areas and '255' otherwise.

Learn() [2/6]

void eVision.EPatternFinder.Learn	(	eVision.EROIBW8	pattern,
		eVision.EFrame	frame )

Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.

Parameters

pattern	Model to be learned (ROI).
frame	Reference frame of the learned image

Learning another pattern erases the information stored for the first one. A "don't care area" can be set as argument, allowing to mask and not take into account certain parts of the pattern while learning. The "don't care area" mask should have the same size as the pattern or as its eventual parent image. The mask should be a bi-level image with pixel - values of '0' for ignored areas and '255' otherwise.

Learn() [3/6]

void eVision.EPatternFinder.Learn	(	eVision.EROIBW8	pattern,
		eVision.ERegion	region )

Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.

Parameters

pattern	Model to be learned (ROI).
region	Region into the ROI where the learning is performed

Learning another pattern erases the information stored for the first one. A "don't care area" can be set as argument, allowing to mask and not take into account certain parts of the pattern while learning. The "don't care area" mask should have the same size as the pattern or as its eventual parent image. The mask should be a bi-level image with pixel - values of '0' for ignored areas and '255' otherwise.

Learn() [4/6]

void eVision.EPatternFinder.Learn	(	eVision.EROIBW8	pattern,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.

Parameters

pattern	Model to be learned (ROI).
region	Region into the ROI where the learning is performed
frame	Reference frame of the learned image

Learning another pattern erases the information stored for the first one. A "don't care area" can be set as argument, allowing to mask and not take into account certain parts of the pattern while learning. The "don't care area" mask should have the same size as the pattern or as its eventual parent image. The mask should be a bi-level image with pixel - values of '0' for ignored areas and '255' otherwise.

Learn() [5/6]

void eVision.EPatternFinder.Learn	(	eVision.EROIBW8	pattern,
		eVision.EROIBW8	dontCare )

Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.

Parameters

pattern	Model to be learned (ROI).
dontCare	"Don't care" area mask (ROI).

Learning another pattern erases the information stored for the first one. A "don't care area" can be set as argument, allowing to mask and not take into account certain parts of the pattern while learning. The "don't care area" mask should have the same size as the pattern or as its eventual parent image. The mask should be a bi-level image with pixel - values of '0' for ignored areas and '255' otherwise.

Deprecated

Use the overload taking an ERegion instead.

Deprecated in version 25.2. Scheduled to be removed in version 27.6.

Learn() [6/6]

void eVision.EPatternFinder.Learn

(

eVision.EVectorModel

model

)

Learns a given pattern and stores it in the EPatternFinder.EPatternFinder object.

Parameters

model

EVectorModel to be learned.

Learning another pattern erases the information stored for the first one. A "don't care area" can be set as argument, allowing to mask and not take into account certain parts of the pattern while learning. The "don't care area" mask should have the same size as the pattern or as its eventual parent image. The mask should be a bi-level image with pixel - values of '0' for ignored areas and '255' otherwise.

LearnPatterns() [1/4]

void eVision.EPatternFinder.LearnPatterns

(

eVision.EROIBW8[]

patterns

)

Learns multiple (at least two) patterns.

Parameters

patterns

Vector of models to be learned (ROI).

Learning multiple patterns is useful when your object presents slight variations: shape deformation, lighting, perspective,... Each pattern is Learned and Found independently and only the best patterns are kept. The options of the EPatternFinder are used for all of the patterns. We recommend setting a EPatternFinder.MaxOverlap when using this feature.

LearnPatterns() [2/4]

void eVision.EPatternFinder.LearnPatterns	(	eVision.EROIBW8[]	patterns,
		eVision.EFrame	frame )

Learns multiple (at least two) patterns.

Parameters

patterns	Vector of models to be learned (ROI).
frame	Reference frame of the learned image

Learning multiple patterns is useful when your object presents slight variations: shape deformation, lighting, perspective,... Each pattern is Learned and Found independently and only the best patterns are kept. The options of the EPatternFinder are used for all of the patterns. We recommend setting a EPatternFinder.MaxOverlap when using this feature.

LearnPatterns() [3/4]

void eVision.EPatternFinder.LearnPatterns	(	eVision.EROIBW8[]	patterns,
		eVision.ERegion[]	regions )

Learns multiple (at least two) patterns.

Parameters

patterns	Vector of models to be learned (ROI).
regions	Vector of regions into the ROI where the learning is performed

Learning multiple patterns is useful when your object presents slight variations: shape deformation, lighting, perspective,... Each pattern is Learned and Found independently and only the best patterns are kept. The options of the EPatternFinder are used for all of the patterns. We recommend setting a EPatternFinder.MaxOverlap when using this feature.

LearnPatterns() [4/4]

void eVision.EPatternFinder.LearnPatterns	(	eVision.EROIBW8[]	patterns,
		eVision.ERegion[]	regions,
		eVision.EFrame	frame )

Learns multiple (at least two) patterns.

Parameters

patterns	Vector of models to be learned (ROI).
regions	Vector of regions into the ROI where the learning is performed
frame	Reference frame of the learned image

Learning multiple patterns is useful when your object presents slight variations: shape deformation, lighting, perspective,... Each pattern is Learned and Found independently and only the best patterns are kept. The options of the EPatternFinder are used for all of the patterns. We recommend setting a EPatternFinder.MaxOverlap when using this feature.

Load() [1/2]

void eVision.EPatternFinder.Load

(

eVision.ESerializer

serializer

)

Loads an EPatternFinder.The given EPatternFinder must have been created for reading.

Parameters

serializer

Pointer to the ESerializer created for reading.

Load() [2/2]

void eVision.EPatternFinder.Load

(

string

path

)

Loads an EPatternFinder.The given EPatternFinder must have been created for reading.

Parameters

path	The file path.

Save() [1/2]

void eVision.EPatternFinder.Save

(

eVision.ESerializer

serializer

)

Loads an EPatternFinder.The given EPatternFinder must have been created for writing.

Parameters

serializer

Pointer to the ESerializer created for writing.

Save() [2/2]

void eVision.EPatternFinder.Save

(

string

path

)

Loads an EPatternFinder.The given EPatternFinder must have been created for writing.

Parameters

path	The file path.

Property Documentation

AngleBias

float eVision.EPatternFinder.AngleBias

getset

Angle bias, expressed in the current angle unit.

The AngleBias defines the angle offset between the model and the instances. Finding the pattern is performed in range AngleBias +/- EPatternFinder.AngleTolerance. This range should not exceed a full turn. Default: 0.0.

AngleSearchExtent

int eVision.EPatternFinder.AngleSearchExtent

getset

The angular extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.

AngleTolerance

float eVision.EPatternFinder.AngleTolerance

getset

Angle tolerance, expressed in the current angle unit.

The AngleTolerance defines the angle allowance of the instances around the EPatternFinder.AngleBias. Finding the pattern is performed in range EPatternFinder.AngleBias +/- AngleTolerance. This range should not exceed a full turn. A NULL tolerance can be set, in which case the angle bias value is assumed. Default: 0.0.

ComputePerFeaturePointScore

bool eVision.EPatternFinder.ComputePerFeaturePointScore

getset

Whether the EPatternFinder should compute a score for each feature point. The scores are then displayed as a Red-Yellow-Green colormap by EFoundPattern.Draw. Note that the scores correspond to the Point-By-Point variants of EPatternFinder.ContrastMode, so if EPatternFinder.ContrastMode is not a Point-By-Point variant, EFoundPattern.Score isn't exactly the average of the displayed scores for each feature point.

ContrastMode

eVision.EFindContrastMode eVision.EPatternFinder.ContrastMode

getset

Contrast of the instance, as defined in EFindContrastMode.

This is a EPatternType.EPatternType_ConsistentEdges pattern type property. It defines the contrast of regions. Contrast can be normal (as in the model), inverse (inverse contrast of the model), or any (same or inverse contrast of the model). Default: EFindContrastMode.EFindContrastMode_Normal.

FeaturePoints

eVision.EFindFeaturePoint [] eVision.EPatternFinder.FeaturePoints

get

The feature points used by the model.

The feature points are expressed with respect to the parent image of the ROI given as input to the EPatternFinder.Learn method.

FindExtension

int eVision.EPatternFinder.FindExtension

getset

Extension value, that is the pattern margin size (in pixels) that is allowed to go out of the search field.

When a non-NULL value is attributed to the extension, the detection of instances partially out of the ROI is allowed. The extension value defines how much the ROI is extended. Default: 0.

FindTimeOut

ulong eVision.EPatternFinder.FindTimeOut

getset

Time-out for the EPatternFinder.Find method.

If the processing time of one of these functions becomes longer than the set time-out, the processing is stopped and an exception is thrown. In that case, the error code of the exception is EError.EError_TimeoutReached.

The time-out is set in microseconds.

This time-out is not a real time-out. The processing is stopped as soon as possible after the time-out has been reached. This means that the time elapsed effectively in the method can be greater than the time-out itself.

Interpolate

bool eVision.EPatternFinder.Interpolate

getset

Whether interpolation is performed when searching for a pattern occurrence.

By default, matching is done with a one-pixel precision for all degrees of freedom (translation, rotation and scaling). You can use an additional interpolation process to achieve sub-pixel accuracy. This generally leads to an improvement of the sub-pixel accuracy by a factor larger than 10. This is possible only when the found instances match closely the model. A score higher than 0.99 indicates that the instances are a close match of the model. In other words, the instance is considered to be more accurate when the score is higher. The added computational cost is low. Default: true.

LearningDone

bool eVision.EPatternFinder.LearningDone

get

Indicates whether a pattern has already been learned.

LearningHasRegion

bool eVision.EPatternFinder.LearningHasRegion

get

Indicates whether a ERegion was used alongside the learned pattern. Returns false if no learning was performed.

LearnTimeOut

ulong eVision.EPatternFinder.LearnTimeOut

getset

Time-out for the EPatternFinder.Learn and EPatternFinder.LearnPatterns methods.

If the processing time of one of these functions becomes longer than the set time-out, the processing is stopped and an exception is thrown. In that case, the error code of the exception is EError.EError_TimeoutReached.

The time-out is set in microseconds.

This time-out is not a real time-out. The processing is stopped as soon as possible after the time-out has been reached. This means that the time elapsed effectively in the method can be greater than the time-out itself.

LightBalance

float eVision.EPatternFinder.LightBalance

getset

Light balance, between [-1.0, 1.0].

In the EPatternType.EPatternType_ConsistentEdges and EPatternType.EPatternType_ThinStructure modes, the LightBalance property governs the selection of the feature points while learning the model. It drives which edge points are eligible as feature points in the model, by defining a criterion for ignoring those edge points that are not sharp enough. As a consequence, this property will influence the spatial distribution of the feature points. In the aforementioned operating modes, the feature points are the places in the image that exhibit a strong variation in the gray level signal. Mathematically, these places are those at which the magnitude of the gradient is significant. The LightBalance property defines the way the latter threshold on the magnitude of the gradient is computed, through a careful analysis of the dynamics of gradient. The more the LightBalance tends to -1, the more tolerant will be the threshold, and the more edge points will be considered as candidates for becoming feature points. Conversely, as the LightBalance property becomes close to 1, only the points with a high gradient magnitude are taken into consideration. In other words, a small LightBalance defines a loose criterion for defining what an edge point is, whereas a great value implies a conservative criterion. By default, this property is fixed to 0.0. This is an appropriate value for most images which are encountered in industrial machine vision. The LightBalance is automatically set to 0.0 after a learning process. Once the LightBalance is changed, a new learning process has to be done to take the new value into account. An efficient way to see the effect of changing this property is to use the EPatternFinder.DrawModel method.

LocalSearchMode

eVision.ELocalSearchMode eVision.EPatternFinder.LocalSearchMode

getset

Sets the local search mode.

In the multi-stage approach of EasyFind, pattern occurrence candidates are at first found at the coarsest stage. Then, at each of the following stages, their position and score are refined until the last and finest one. This refining is achieved by searching for better candidates in the neighborhood of each of the ones found in the previous stage. The local search mode allows the user to set the extent of this neighborhood. By default, the local search mode is set to ELocalSearchMode.ELocalSearchMode_Basic.

MaxFeaturePoints

uint eVision.EPatternFinder.MaxFeaturePoints

getset

Maximum number of feature points at the fine stage.

Default: 1024. Reserved use.

MaximumOverlapping

float eVision.EPatternFinder.MaximumOverlapping

getset

Deprecated

Use EPatternFinder.MaxOverlap instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

MaxInitialCandidates

uint eVision.EPatternFinder.MaxInitialCandidates

getset

Maximum number of initial candidates.

During the search for matching patterns, EasyFind considers a set of candidates that it progressively refines. The maximum number of initial candidates must be greater or equal than the number of instances to be found (see EPatternFinder.MaxInstances). A large number of initial candidates can help finding difficult or partial match but at the cost of increasing processing time. A small number can help speeding up the find process. By default, the value for maximum number of initial candidates is 0, indicating that the value is chosen internally.

MaxInstances

uint eVision.EPatternFinder.MaxInstances

getset

Maximum number of instances to be found.

Default: 1.

MaxOverlap

float eVision.EPatternFinder.MaxOverlap

getset

Overlapping tolerance.

0.0 means all found patterns must be disconnected, 1.0 means they can fully overlap. Default: 1.0.

MinFeaturePoints

uint eVision.EPatternFinder.MinFeaturePoints

getset

Minimum number of feature points at the coarse stage.

Default: 8. Reserved use.

MinScore

float eVision.EPatternFinder.MinScore

getset

Minimum score of found instances, between [-1.0, 1.0].

Instances with a score under the MinScore will not be returned.

NumLearnedPatterns

uint eVision.EPatternFinder.NumLearnedPatterns

get

Indicates the number of patterns learnt. 0 is returned if no learning was performed.

PatternType

eVision.EPatternType eVision.EPatternFinder.PatternType

getset

Pattern type, as defined in EPatternType.

This property informs the EPatternFinder.EPatternFinder of the general nature of the model to be learned. Default: EPatternType.EPatternType_ConsistentEdges.

Pivot

eVision.EPoint eVision.EPatternFinder.Pivot

getset

Reference point in the model.

The coordinates of the reference point are relative to the upper left corner of the model. The location of an instance (Coordinates (X,Y)) is the location of its reference point defined in the model. By default, the pivot is a EPoint set to the pattern center. EPoint is a structure that contains two x and y float values.

ReductionMode

eVision.EReductionMode eVision.EPatternFinder.ReductionMode

getset

The reduction mode that is to be used when learning the model (automatic or manual), as defined in EReductionMode.

Specifies whether the best-guess method should be used to assert the level of reduction that will be used when learning the model. If this property is set to EReductionMode.EReductionMode_Manual, it is up to the user to provide a suitable reduction strength. This value is only used when learning the model. Default: EReductionMode.EReductionMode_Auto, which means that the best-guess algorithm is used by default.

ReductionStrength

float eVision.EPatternFinder.ReductionStrength

getset

The reduction strength that is to be used when learning the model, between 0 and 1.

Specifies the reduction strength for learning the model (encoded as a percentage). Its precise semantics depends on the reduction mode (see the EPatternFinder.ReductionMode property):

• In the automatic reduction mode, its value is undefined until a model is learned. When a model is learned (i.e. after a call to EPatternFinder.Learn), the value of this property can be read, in which case it reflects the reduction strength that has been automatically chosen by the best-guess algorithm.
• In the manual reduction mode, this property must be set by the user and is kept constant throughout the entire lifetime of the object. The new value of the property is only used at the following call to EPatternFinder.Learn. This value only has an effect when learning the model. Default: The default value depends on the value of the EPatternFinder.ReductionMode property. Allowed values: Floating-point number in the interval [0..1]. When multiple patterns are learned and reduction mode is automatic, the reduction strength corresponding to the first pattern is returned.

ScaleBias

float eVision.EPatternFinder.ScaleBias

getset

Scale bias, expressed in units (not in percent).

The ScaleBias defines the scale factor between the model and the instances. Finding the pattern is performed in range ScaleBias +/- ScaleTolerance. This range should not exceed [0.5..2.5] (50% to 250% scaling). Default: 1.0 (100%).

ScaleSearchExtent

int eVision.EPatternFinder.ScaleSearchExtent

getset

The scaling extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.

ScaleTolerance

float eVision.EPatternFinder.ScaleTolerance

getset

Scale tolerance, expressed in units (not in percent).

The ScaleTolerance defines the scale allowance of the instances around the EPatternFinder.ScaleBias. Finding the pattern is performed in range EPatternFinder.ScaleBias +/- ScaleTolerance. This range should not exceed [0.5..2] (50 % to 200 % scaling). A NULL tolerance can be set, in which case the scale bias value is assumed. Default: 0.0.

ThinStructureMode

eVision.EThinStructureMode eVision.EPatternFinder.ThinStructureMode

getset

Mode for EPatternType.EPatternType_ThinStructure, as defined in EThinStructureMode.

EThinStructureMode informs EasyFind if thin elements in the model are darker or brighter than regions. Default: EThinStructureMode.EThinStructureMode_Auto, which detects the best mode between dark or bright.

XSearchExtent

int eVision.EPatternFinder.XSearchExtent

getset

The X-axis extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.

YSearchExtent

int eVision.EPatternFinder.YSearchExtent

getset

The Y-axis extension of the search neighborhood. Only odd values are allowed for this parameter. See the EPatternFinder.LocalSearchMode property description for further details.