org.openimaj.image.analysis.algorithm

Class FourierTemplateMatcher

java.lang.Object

org.openimaj.image.analysis.algorithm.FourierTemplateMatcher

All Implemented Interfaces:

ImageAnalyser<FImage>

public class FourierTemplateMatcher
extends Object
implements ImageAnalyser<FImage>

Basic template matching for FImages. Template matching is performed in the frequency domain using an FFT.

The implementation is heavily inspired by the OpenCV code.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FourierTemplateMatcher.Mode Different algorithms for comparing templates to images.

Constructor Summary

Constructors

Constructor and Description
FourierTemplateMatcher(FImage template, FourierTemplateMatcher.Mode mode) Default constructor with the template to match.
FourierTemplateMatcher(FImage template, Rectangle bounds, FourierTemplateMatcher.Mode mode) Construct with the template to match and the bounds rectangle in which to search.

Method Summary

Modifier and Type	Method and Description
void	analyseImage(FImage image) Perform template matching.
FValuePixel[]	getBestResponses(int numResponses) Get the top-N "best" responses found by the template matcher.
FImage	getResponseMap()
Rectangle	getSearchBounds()
int	getXOffset()
int	getYOffset()
void	setSearchBounds(Rectangle searchBounds) Set the search bounds rectangle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FourierTemplateMatcher

public FourierTemplateMatcher(FImage template,
                              FourierTemplateMatcher.Mode mode)

Default constructor with the template to match. When matching is performed by analyseImage(FImage), the whole image will be searched.

Parameters:

template - The template.

mode - The matching mode.

FourierTemplateMatcher

public FourierTemplateMatcher(FImage template,
                              Rectangle bounds,
                              FourierTemplateMatcher.Mode mode)

Construct with the template to match and the bounds rectangle in which to search. The search bounds rectangle is defined with respect to the centre of the template.

Parameters:

template - The template

bounds - The bounding box for search.

mode - The matching mode.

Method Detail

getSearchBounds

public Rectangle getSearchBounds()

Returns:

the search bound rectangle

setSearchBounds

public void setSearchBounds(Rectangle searchBounds)

Set the search bounds rectangle. The search bounds rectangle is defined with respect to the centre of the template. Setting to null results in the entire image being searched.

Parameters:

searchBounds - the search bounds to set

analyseImage

public void analyseImage(FImage image)

Perform template matching. If a bounds rectangle is has not been set or is null, then the whole image will be searched. Otherwise the area of the image which lies in the previously set search bounds will be searched.

Specified by:

analyseImage in interface ImageAnalyser<FImage>

Parameters:

image - The image to process in place.

See Also:

ImageAnalyser.analyseImage(org.openimaj.image.Image)

getBestResponses

public FValuePixel[] getBestResponses(int numResponses)

Get the top-N "best" responses found by the template matcher.

Parameters:

numResponses - The number of responses

Returns:

the best responses found

getXOffset

public int getXOffset()

Returns:

The x-offset of the top-left of the response map returned by getResponseMap() to the original image analysed by analyseImage(FImage).

getYOffset

public int getYOffset()

Returns:

The y-offset of the top-left of the response map returned by getResponseMap() to the original image analysed by analyseImage(FImage).

getResponseMap

public FImage getResponseMap()

Returns:

The responseMap generated from the last call to analyseImage(FImage)