org.openimaj.image.analysis.algorithm

Class TemplateMatcher

java.lang.Object

org.openimaj.image.analysis.algorithm.TemplateMatcher

All Implemented Interfaces:

ImageAnalyser<FImage>

public class TemplateMatcher
extends Object
implements ImageAnalyser<FImage>

Basic template matching for FImages. Template matching is performed in the spatial domain.

Author:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
TemplateMatcher(FImage template, TemplateMatcher.Mode mode) Default constructor with the template to match and the mode with which to estimate template responses.
TemplateMatcher(FImage template, TemplateMatcher.Mode mode, Rectangle bounds) Construct with the template to match, the mode with which to estimate template responses 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.
static FValuePixel[]	getBestResponses(int numResponses, FImage responseMap, int offsetX, int offsetY, Comparator<FValuePixel> comparator) Get the top-N "best" responses found by the template matcher.
FImage	getResponseMap()
Rectangle	getSearchBounds()
FImage	getTemplate()
int	getXOffset()
int	getYOffset()
static void	main(String[] args) Testing
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

TemplateMatcher

public TemplateMatcher(FImage template,
                       TemplateMatcher.Mode mode)

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

Parameters:

template - The template

mode - The mode.

TemplateMatcher

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

Construct with the template to match, the mode with which to estimate template responses 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

mode - The mode.

bounds - The bounding box for search.

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

getBestResponses

public static FValuePixel[] getBestResponses(int numResponses,
                                             FImage responseMap,
                                             int offsetX,
                                             int offsetY,
                                             Comparator<FValuePixel> comparator)

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

Parameters:

numResponses - The number of responses

responseMap - The response map

offsetX - the amount to shift pixels in the x direction

offsetY - the amount to shift pixels in the y direction

comparator - the comparator for determining the "best" 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)

getTemplate

public FImage getTemplate()

Returns:

the template held by the matcher; this might be different to the image used in construction as it might have been pre-processed.

main

public static void main(String[] args)
                 throws IOException

Testing

Parameters:

args -

Throws:

IOException