You are here: Start » FIL.NET » FIS.LocateSingleObject_NCC Method

FIS.LocateSingleObject_NCC Method

Finds a single occurrence of a predefined template on an image by analysing the normalized correlation between pixel values.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

public static void LocateSingleObject_NCC
(
	FilNet.Image inImage,
	NullableRef<FilNet.ShapeRegion> inSearchRegion,
	FilNet.CoordinateSystem2D? inSearchRegionAlignment,
	FilNet.GrayModel inGrayModel,
	int inMinPyramidLevel,
	int? inMaxPyramidLevel,
	bool inIgnoreBoundaryObjects,
	float inMinScore,
	float? inMaxBrightnessRatio,
	float? inMaxContrastRatio,
	INullable<FilNet.Object2D> outObject,
	NullableValue<int> outPyramidHeight,
	NullableRef<FilNet.ShapeRegion> outAlignedSearchRegion,
	IList<FilNet.Image> diagImagePyramid,
	IList<FilNet.Image> diagMatchPyramid,
	INullable<List<float>> diagScores
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageImage on which object occurrence will be searched.
inSearchRegionFilNet.NullableRef<FilNet.ShapeRegion>Range of possible object centers. Default value: ftl::NIL.
inSearchRegionAlignmentFilNet.CoordinateSystem2D?Adjusts the region of interest to the position of the inspected object. Default value: ftl::NIL.
inGrayModelFilNet.GrayModelModel of objects to be searched.
inMinPyramidLevelint<0, 12>0Defines the lowest pyramid level at which object position is still refined. Default value: 0.
inMaxPyramidLevelint?<0, 12>3Defines the total 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.
inMinScorefloat<-1.0f, 1.0f>0.7fMinimum score of object candidates accepted at each pyramid level. Default value: 0.7f.
inMaxBrightnessRatiofloat?<1.0f, INF>Defines the maximal deviation of the mean brightness of the model object and the object present in the image. Default value: ftl::NIL.
inMaxContrastRatiofloat?<1.0f, INF>Defines the maximal deviation of the brightness standard deviation of the model object and the object present in the image. Default value: ftl::NIL.
outObjectFilNet.INullable<FilNet.Object2D>Found object. This parameter cannot be null.
outPyramidHeightFilNet.NullableValue<int>Highest pyramid level used to speed up computations. Can be null to skip this parameter calculation.
outAlignedSearchRegionFilNet.NullableRef<FilNet.ShapeRegion>Transformed input shape region. Can be null to skip this parameter calculation.
diagImagePyramidSystem.Collections.Generic.IList<FilNet.Image>Pyramid of iteratively downsampled input image.
diagMatchPyramidSystem.Collections.Generic.IList<FilNet.Image>Candidate object locations found at each pyramid level.
diagScoresFilNet.INullable<System.Collections.Generic.List<float>>Scores of the found object at each pyramid level. This parameter cannot be null.

Function Overrides

See also