You are here: Start » FIL.NET » Invoke.LocateSingleObject_SAD

Invoke.LocateSingleObject_SAD

Finds a single occurrence of a predefined template on an image by analysing the Square Average Difference between pixel values.

Namespace:Fil
Assembly:FilNet.dll

Syntax

C++
C#
 
public static void LocateSingleObject_SAD
(
	Fil.Image inImage,
	Optional<Fil.ShapeRegion> inSearchRegion,
	Optional<Fil.CoordinateSystem2D> inSearchRegionAlignment,
	Fil.GrayModel inGrayModel,
	int inMinPyramidLevel,
	Optional<int> inMaxPyramidLevel,
	bool inIgnoreBoundaryObjects,
	float inMaxDifference,
	Conditional<Fil.Object2D> outObject,
	Optional<int> outPyramidHeight,
	Optional<Fil.ShapeRegion> outAlignedSearchRegion,
	Diagnostic<List<Fil.Image>> diagImagePyramid,
	Diagnostic<List<Fil.Image>> diagMatchPyramid,
	Diagnostic<Conditional<List<float>>> diagScores
)

Parameters

Name Type Range Default Description
inImageFil.ImageImage on which model occurrence will be searched.
inSearchRegionFtl.Optional<Fil.ShapeRegion>Possible centers of the object occurrence. Default value: ftl::NIL.
inSearchRegionAlignmentFtl.Optional<Fil.CoordinateSystem2D>Adjusts the region of interest to the position of the inspected object. Default value: ftl::NIL.
inGrayModelFil.GrayModelModel which will be sought.
inMinPyramidLevelint<0, 12>0Defines the highest resolution level. Default value: 0.
inMaxPyramidLevelFtl.Optional<int><0, 12>3Defines the number of reduced resolution levels that can be used to speed up computations. Default value: 3.
inIgnoreBoundaryObjectsboolFalseFlag indicating whether objects crossing image boundary should be ignored or not. Default value: False.
inMaxDifferencefloat<0.0f, INF>0.0fMaximum accepted average difference between pixel values. Default value: 0.0f.
outObjectFtl.Conditional<Fil.Object2D>Found object.
outPyramidHeightFtl.Optional<int>Highest pyramid level used to speed up computations.
outAlignedSearchRegionFtl.Optional<Fil.ShapeRegion>Transformed input shape region.
diagImagePyramidFil.Diagnostic<System.Collections.Generic.List<Fil.Image>>Pyramid of iteratively downsampled input image.
diagMatchPyramidFil.Diagnostic<System.Collections.Generic.List<Fil.Image>>Locations found on each pyramid level.
diagScoresFil.Diagnostic<Ftl.Conditional<System.Collections.Generic.List<float>>>Scores of found match on each pyramid level.

See also