org.openimaj.image.analysis.algorithm

Enum TemplateMatcher.Mode

java.lang.Object

java.lang.Enum<TemplateMatcher.Mode>

org.openimaj.image.analysis.algorithm.TemplateMatcher.Mode

All Implemented Interfaces:

Serializable, Comparable<TemplateMatcher.Mode>

Enclosing class:

TemplateMatcher

public static enum TemplateMatcher.Mode
extends Enum<TemplateMatcher.Mode>

Different algorithms for comparing templates to images.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CORRELATION Compute the score at a point as the summed product between the image and the template with the top-left at the point given.
CORRELATION_COEFFICIENT Compute the score at a point as the summed product between the mean-centered image patch and the mean-centered template with the top-left at the point given.
NORM_CORRELATION Compute the normalised score at a point as the summed product between the image and the template with the top-left at the point given.
NORM_CORRELATION_COEFFICIENT Compute the normalised score at a point as the summed product between the mean-centered image patch and the mean-centered template with the top-left at the point given.
NORM_SUM_SQUARED_DIFFERENCE Compute the normalised score at a point as the sum-squared difference between the image and the template with the top-left at the given point.
SUM_SQUARED_DIFFERENCE Compute the score at a point as the sum-squared difference between the image and the template with the top-left at the given point.

Method Summary

Modifier and Type	Method and Description
protected abstract float	computeMatchScore(FImage image, FImage template, int x, int y, Object workingSpace) Compute the matching score between the image and template, with the top-left of the template at (x, y) in the image.
abstract float	computeMatchScore(float[][] img, int x, int y, float[][] template, int templateX, int templateY, int templateWidth, int templateHeight) Compute the matching score between the image and template, with the top-left of the template at (x, y) in the image.
protected FImage	prepareTemplate(FImage template) Prepare the template if necessary.
protected Object	prepareWorkingSpace(FImage template) Prepare an object to hold the working space required by the mode during score computation.
abstract boolean	scoresAscending() Are the scores ascending (i.e.
static TemplateMatcher.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static TemplateMatcher.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUM_SQUARED_DIFFERENCE

public static final TemplateMatcher.Mode SUM_SQUARED_DIFFERENCE

Compute the score at a point as the sum-squared difference between the image and the template with the top-left at the given point. The TemplateMatcher will account for the offset to the centre of the template internally.

NORM_SUM_SQUARED_DIFFERENCE

public static final TemplateMatcher.Mode NORM_SUM_SQUARED_DIFFERENCE

Compute the normalised score at a point as the sum-squared difference between the image and the template with the top-left at the given point. The TemplateMatcher will account for the offset to the centre of the template internally.

CORRELATION

public static final TemplateMatcher.Mode CORRELATION

Compute the score at a point as the summed product between the image and the template with the top-left at the point given. The TemplateMatcher will account for the offset to the centre of the template internally.

NORM_CORRELATION

public static final TemplateMatcher.Mode NORM_CORRELATION

Compute the normalised score at a point as the summed product between the image and the template with the top-left at the point given. The TemplateMatcher will account for the offset to the centre of the template internally.

CORRELATION_COEFFICIENT

public static final TemplateMatcher.Mode CORRELATION_COEFFICIENT

Compute the score at a point as the summed product between the mean-centered image patch and the mean-centered template with the top-left at the point given. The TemplateMatcher will account for the offset to the centre of the template internally.

NORM_CORRELATION_COEFFICIENT

public static final TemplateMatcher.Mode NORM_CORRELATION_COEFFICIENT

Compute the normalised score at a point as the summed product between the mean-centered image patch and the mean-centered template with the top-left at the point given. The TemplateMatcher will account for the offset to the centre of the template internally.

Method Detail

values

public static TemplateMatcher.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TemplateMatcher.Mode c : TemplateMatcher.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TemplateMatcher.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

computeMatchScore

protected abstract float computeMatchScore(FImage image,
                                           FImage template,
                                           int x,
                                           int y,
                                           Object workingSpace)

Compute the matching score between the image and template, with the top-left of the template at (x, y) in the image.

Parameters:

image - The image.

template - The template.

x - The x-ordinate top-left of the template in the image

y - The y-ordinate top-left of the template in the image

workingSpace - The working space created by #prepareWorkingSpace()

Returns:

The match score.

computeMatchScore

public abstract float computeMatchScore(float[][] img,
                                        int x,
                                        int y,
                                        float[][] template,
                                        int templateX,
                                        int templateY,
                                        int templateWidth,
                                        int templateHeight)

Compute the matching score between the image and template, with the top-left of the template at (x, y) in the image. The coordinates of the template can be specified, so it is possible for the actual template to be a sub-image of the given data.

Parameters:

img - the image data

x - the x-ordinate of the top-left of the template

y - the y-ordinate of the top-left of the template

template - the template data

templateX - the top-left x-ordinate of the template in the template data

templateY - the top-left y-ordinate of the template in the template data

templateWidth - the width of the template in the template data

templateHeight - the height of the template in the template data

Returns:

the match score.

scoresAscending

public abstract boolean scoresAscending()

Are the scores ascending (i.e. bigger is better) or descending (smaller is better)?

Returns:

true is bigger scores are better; false if smaller scores are better.

prepareTemplate

protected FImage prepareTemplate(FImage template)

Prepare the template if necessary. The default implementation just returns the template, but subclasses can override.

Parameters:

template - the template image

Returns:

the processed template image

prepareWorkingSpace

protected Object prepareWorkingSpace(FImage template)

Prepare an object to hold the working space required by the mode during score computation. Most modes don't require this, so the default implementation returns null, but it can be overridden.

Parameters:

template - the template

Returns:

an object representing the required working space for the computeMatchScore(FImage, FImage, int, int, Object) method.