Correlation Class Reference

Correlation functions that come with the Minos library. More...

Static Public Member Functions
static SearchResult[]	SearchAll (ImagePlane plane, ImagePlane template, double density, Area2D aoi, double threshold, int radius)
	Find all correlation matches of the template in the image plane . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results depends on the scan direction defined by the aoi .
static SearchResult[]	SearchAll (ImagePlane plane, ImagePlane template, double density, double threshold, int radius)
	Find all correlation matches of the template in the image plane . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results is left/top to right/bottom.
static SearchResult[]	SearchAll (Image image, Image template, double density, double threshold, int radius)
	Find all correlation matches of the template in the image . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results is left/top to right/bottom.
static SearchResult[]	SearchAll (Image image, Image template, double density, Area2D aoi, double threshold, int radius)
	Find all correlation matches of the template in the image . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results depends on the scan direction defined by the aoi .
static SearchResult	Search (ImagePlane plane, ImagePlane template, double density, Area2D aoi)
	Find the best correlation match of the template in the plane with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.
static SearchResult	Search (Image image, Image template, double density, Area2D aoi)
	Find the best correlation match of the template in the image with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.
static SearchResult	Search (Image image, Image template, double density)
	Find the best correlation match of the template in the image with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.
static SearchResult	Search (ImagePlane plane, ImagePlane template, double density)
	Find the best correlation match of the template in the plane with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.

Detailed Description

Correlation functions that come with the Minos library.

Member Function Documentation

Search() [1/4]

static SearchResult Search ( Image image, Image template, double density )

static

Find the best correlation match of the template in the image with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.

Parameters

image	image in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches

Returns

best result that was detected (SearchResult.Empty if none was found)

Exceptions

ArgumentNullException	If image or template are null
ObjectDisposedException	If image or template has already been disposed
ArgumentOutOfRangeException	If the parameter value is invalid or the density exceeds the range [0...1].

Search() [2/4]

static SearchResult Search ( Image image, Image template, double density, Area2D aoi )

static

Find the best correlation match of the template in the image with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.

Parameters

image	image in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches
aoi	area in which to look for correlation matches

Returns

best result that was detected (SearchResult.Empty if none was found)

Exceptions

ArgumentNullException	If image or template are null
ObjectDisposedException	If image or template has already been disposed
ArgumentOutOfRangeException	If the parameter value is invalid or the density exceeds the range [0...1].

Search() [3/4]

static SearchResult Search ( ImagePlane plane, ImagePlane template, double density )

static

Find the best correlation match of the template in the plane with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.

Parameters

plane	image plane in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches

Returns

best result that was detected (SearchResult.Empty if none was found)

Exceptions

ArgumentNullException	If plane or template are null
ObjectDisposedException	If plane or template has already been disposed
ArgumentOutOfRangeException	If the parameter value is invalid or the density exceeds the range [0...1].

Search() [4/4]

static SearchResult Search ( ImagePlane plane, ImagePlane template, double density, Area2D aoi )

static

Find the best correlation match of the template in the plane with sub-pixel accuracy. The amount of sub pixel accuracy that may be achieved depends on the size of the template.

Parameters

plane	image plane in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches
aoi	area in which to look for correlation matches

Returns

best result that was detected (SearchResult.Empty if none was found)

Exceptions

ArgumentNullException	If the Parent of plane or template is null
ObjectDisposedException	If the Parent of plane or template has already been disposed
ArgumentOutOfRangeException	If the density exceeds the range [0...1].

SearchAll() [1/4]

static SearchResult[] SearchAll ( Image image, Image template, double density, Area2D aoi, double threshold, int radius )

static

Find all correlation matches of the template in the image . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results depends on the scan direction defined by the aoi .

Parameters

image	image in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches
aoi	area in which to look for correlation matches
threshold	minimum correlation for the results to be reported
radius	minimum distance between two positive results

Returns

the list of extracted results

Exceptions

ArgumentNullException	If image or template are null
ObjectDisposedException	If image or template has already been disposed
ArgumentOutOfRangeException	If the parameter density or threshold exceeds the range [0...1].

SearchAll() [2/4]

static SearchResult[] SearchAll ( Image image, Image template, double density, double threshold, int radius )

static

Find all correlation matches of the template in the image . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results is left/top to right/bottom.

Parameters

image	image in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches
threshold	minimum correlation for the results to be reported
radius	minimum distance between two positive results

Returns

the list of extracted results

Exceptions

ArgumentNullException	If image or template are null
ObjectDisposedException	If image or template has already been disposed
ArgumentOutOfRangeException	If the parameter density or threshold exceeds the range [0...1].

SearchAll() [3/4]

static SearchResult[] SearchAll ( ImagePlane plane, ImagePlane template, double density, Area2D aoi, double threshold, int radius )

static

Find all correlation matches of the template in the image plane . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results depends on the scan direction defined by the aoi .

Parameters

plane	image plane in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches
aoi	area in which to look for correlation matches
threshold	minimum correlation for the results to be reported
radius	minimum distance between two positive results

Returns

the list of extracted results

Exceptions

ArgumentNullException	If the Parent of plane or template ist null
ObjectDisposedException	If the Parent of plane or template has already been disposed
ArgumentOutOfRangeException	If the density or threshold exceeds the range [0...1].

SearchAll() [4/4]

static SearchResult[] SearchAll ( ImagePlane plane, ImagePlane template, double density, double threshold, int radius )

static

Find all correlation matches of the template in the image plane . If the number of results exceeds 32767, then the result list will be truncated at that number. The order of the results is left/top to right/bottom.

Parameters

plane	image plane in which to look for correlation matches
template	template with which to look for correlation matches
density	scan density with which to look for correlation matches
threshold	minimum correlation for the results to be reported
radius	minimum distance between two positive results

Returns

the list of extracted results

Exceptions

ArgumentNullException	If the Parent of plane or template ist null
ObjectDisposedException	If the Parent of plane or template has already been disposed
ArgumentOutOfRangeException	If the density or threshold exceeds the range [0...1].