org.openimaj.image.analysis.algorithm

Enum FourierTemplateMatcher.Mode

java.lang.Object

java.lang.Enum<FourierTemplateMatcher.Mode>

org.openimaj.image.analysis.algorithm.FourierTemplateMatcher.Mode

All Implemented Interfaces:

Serializable, Comparable<FourierTemplateMatcher.Mode>

Enclosing class:

FourierTemplateMatcher

public static enum FourierTemplateMatcher.Mode
extends Enum<FourierTemplateMatcher.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.
CORRELATION_COEFFICIENT Compute the score at a point as the summed product between the mean-centered image patch and the mean-centered template.
NORM_CORRELATION Compute the normalised score at a point as the summed product between the image and the template.
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.
NORM_SUM_SQUARED_DIFFERENCE Compute the normalised score at a point as the sum-squared difference between the image and the template.
SUM_SQUARED_DIFFERENCE Compute the score at a point as the sum-squared difference between the image and the template.

Method Summary

Modifier and Type	Method and Description
abstract void	processCorrelationMap(FImage img, FImage template, FImage corr) Process the cross-correlation image to the contain the relevant output values for the chosen mode.
abstract boolean	scoresAscending() Are the scores ascending (i.e.
static FourierTemplateMatcher.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FourierTemplateMatcher.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 FourierTemplateMatcher.Mode SUM_SQUARED_DIFFERENCE

Compute the score at a point as the sum-squared difference between the image and the template.

NORM_SUM_SQUARED_DIFFERENCE

public static final FourierTemplateMatcher.Mode NORM_SUM_SQUARED_DIFFERENCE

Compute the normalised score at a point as the sum-squared difference between the image and the template.

CORRELATION

public static final FourierTemplateMatcher.Mode CORRELATION

Compute the score at a point as the summed product between the image and the template.

NORM_CORRELATION

public static final FourierTemplateMatcher.Mode NORM_CORRELATION

Compute the normalised score at a point as the summed product between the image and the template.

CORRELATION_COEFFICIENT

public static final FourierTemplateMatcher.Mode CORRELATION_COEFFICIENT

Compute the score at a point as the summed product between the mean-centered image patch and the mean-centered template.

NORM_CORRELATION_COEFFICIENT

public static final FourierTemplateMatcher.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.

Method Detail

values

public static FourierTemplateMatcher.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 (FourierTemplateMatcher.Mode c : FourierTemplateMatcher.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 FourierTemplateMatcher.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

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.

processCorrelationMap

public abstract void processCorrelationMap(FImage img,
                                           FImage template,
                                           FImage corr)

Process the cross-correlation image to the contain the relevant output values for the chosen mode.

Parameters:

img - the image

template - the template

corr - the cross correlation map produced by FourierCorrelation.