boofcv.alg.feature.detect.template

Class TemplateCorrelationFFT

java.lang.Object

boofcv.alg.feature.detect.template.TemplateCorrelationFFT

All Implemented Interfaces:

TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

public class TemplateCorrelationFFT
extends java.lang.Object
implements TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Correlation based template matching which uses FFT

Constructor Summary

Constructors

Constructor and Description
TemplateCorrelationFFT()

Method Summary

Modifier and Type	Method and Description
int	getBorderX0() Thickness of border along the image left side (lower extent)
int	getBorderX1() Thickness of border along the image right side (upper extent)
int	getBorderY0() Thickness of border along the image top (lower extent)
int	getBorderY1() Thickness of border along the image bottom (upper extent)
boofcv.struct.image.GrayF32	getIntensity() Contains results of template matching.
boolean	isBorderProcessed() Does this algorithm process the image's border.
void	process(boofcv.struct.image.GrayF32 template) Matches the template to the image and computes an intensity image.
void	process(boofcv.struct.image.GrayF32 template, boofcv.struct.image.GrayF32 mask) Matches the template with a mask to the image and computes an intensity image.
void	setInputImage(boofcv.struct.image.GrayF32 image) Specifies the input image which the template is going ot be matched against

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateCorrelationFFT

public TemplateCorrelationFFT()

Method Detail

setInputImage

public void setInputImage(boofcv.struct.image.GrayF32 image)

Description copied from interface: TemplateMatchingIntensity

Specifies the input image which the template is going ot be matched against

Specified by:

setInputImage in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Parameters:

image - Input image. Not modified.

process

public void process(boofcv.struct.image.GrayF32 template)

Description copied from interface: TemplateMatchingIntensity

Matches the template to the image and computes an intensity image. Must call TemplateMatchingIntensity.setInputImage(ImageBase) first

Specified by:

process in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Parameters:

template - Template image. Must be equal to or smaller than the input image. Not modified.

process

public void process(boofcv.struct.image.GrayF32 template,
                    boofcv.struct.image.GrayF32 mask)

Description copied from interface: TemplateMatchingIntensity

Matches the template with a mask to the image and computes an intensity image. Must call TemplateMatchingIntensity.setInputImage(ImageBase) first

Specified by:

process in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Parameters:

template - Template image. Must be equal to or smaller than the input image. Not modified.

mask - Mask that identifies how translucent pixels. 0 = 100% transparent and all values above increase its importance. Typical values are 0 to 255 for integer images and 0.0 to 1.0 for floating point.

getIntensity

public boofcv.struct.image.GrayF32 getIntensity()

Description copied from interface: TemplateMatchingIntensity

Contains results of template matching. Higher intensity values correspond to a better match. Local matches can be found using NonMaxSuppression. See comment about processing the image border.

Specified by:

getIntensity in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Returns:

Feature intensity

isBorderProcessed

public boolean isBorderProcessed()

Description copied from interface: TemplateMatchingIntensity

Does this algorithm process the image's border. If it does not process the border

Specified by:

isBorderProcessed in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Returns:

true if the border is processed and false otherwise.

getBorderX0

public int getBorderX0()

Description copied from interface: TemplateMatchingIntensity

Thickness of border along the image left side (lower extent)

Specified by:

getBorderX0 in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Returns:

Border in pixels

getBorderX1

public int getBorderX1()

Description copied from interface: TemplateMatchingIntensity

Thickness of border along the image right side (upper extent)

Specified by:

getBorderX1 in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Returns:

Border in pixels

getBorderY0

public int getBorderY0()

Description copied from interface: TemplateMatchingIntensity

Thickness of border along the image top (lower extent)

Specified by:

getBorderY0 in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Returns:

Border in pixels

getBorderY1

public int getBorderY1()

Description copied from interface: TemplateMatchingIntensity

Thickness of border along the image bottom (upper extent)

Specified by:

getBorderY1 in interface TemplateMatchingIntensity<boofcv.struct.image.GrayF32>

Returns:

Border in pixels