boofcv.abst.feature.describe

Class WrapDescribePixelRegionNCC<T extends boofcv.struct.image.ImageSingleBand>

java.lang.Object

boofcv.abst.feature.describe.WrapDescribePixelRegionNCC<T>

All Implemented Interfaces:

DescribeRegionPoint<T,NccFeature>, DescriptorInfo<NccFeature>

public class WrapDescribePixelRegionNCC<T extends boofcv.struct.image.ImageSingleBand>
extends java.lang.Object
implements DescribeRegionPoint<T,NccFeature>

Wrapper around DescribePointPixelRegionNCC for DescribeRegionPoint.

Constructor Summary

Constructors

Constructor and Description
WrapDescribePixelRegionNCC(DescribePointPixelRegionNCC<T> alg, java.lang.Class<T> imageType)

Method Summary

Modifier and Type	Method and Description
NccFeature	createDescription() Creates new description instance which can be processed by this class
double	getCanonicalWidth() Returns the width of the square (or approximation of) sample region at a scale of one.
java.lang.Class<NccFeature>	getDescriptionType() The type of region descriptor generated
boofcv.struct.image.ImageType<T>	getImageType() Description of the type of image it can process
boolean	process(double x, double y, double orientation, double scale, NccFeature storage) Extract a description of the local image at the given point, scale, and orientation.
boolean	requiresOrientation() True if the descriptor uses orientation information.
boolean	requiresScale() If scale information is used when computing the descriptor.
void	setImage(T image) Specified the image which is to be processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapDescribePixelRegionNCC

public WrapDescribePixelRegionNCC(DescribePointPixelRegionNCC<T> alg,
                                  java.lang.Class<T> imageType)

Method Detail

createDescription

public NccFeature createDescription()

Description copied from interface: DescriptorInfo

Creates new description instance which can be processed by this class

Specified by:

createDescription in interface DescriptorInfo<NccFeature>

Returns:

New descriptor

setImage

public void setImage(T image)

Description copied from interface: DescribeRegionPoint

Specified the image which is to be processed.

Specified by:

setImage in interface DescribeRegionPoint<T extends boofcv.struct.image.ImageSingleBand,NccFeature>

Parameters:

image - The image which contains the features.

process

public boolean process(double x,
                       double y,
                       double orientation,
                       double scale,
                       NccFeature storage)

Description copied from interface: DescribeRegionPoint

Extract a description of the local image at the given point, scale, and orientation. WARNING: Check the returned value to make sure a description was actually computed. Some implementations might now allow features to extend outside the image border and will return false.

Specified by:

process in interface DescribeRegionPoint<T extends boofcv.struct.image.ImageSingleBand,NccFeature>

Parameters:

x - Coordinate of the point.

y - Coordinate of the point.

orientation - Direction the feature is pointing at in radians. 0 = x-axis PI/2 = y-axis

scale - Scale at which the feature was found.

storage - (output) Storage for extracted feature. Use DescriptorInfo.createDescription() to create descriptor.

Returns:

true if a descriptor can computed or false if not.

requiresScale

public boolean requiresScale()

Description copied from interface: DescribeRegionPoint

If scale information is used when computing the descriptor.

Specified by:

requiresScale in interface DescribeRegionPoint<T extends boofcv.struct.image.ImageSingleBand,NccFeature>

Returns:

if scale needs to be provided or not

requiresOrientation

public boolean requiresOrientation()

Description copied from interface: DescribeRegionPoint

True if the descriptor uses orientation information.

Specified by:

requiresOrientation in interface DescribeRegionPoint<T extends boofcv.struct.image.ImageSingleBand,NccFeature>

Returns:

if orientation needs to be provided or not

getImageType

public boofcv.struct.image.ImageType<T> getImageType()

Description copied from interface: DescribeRegionPoint

Description of the type of image it can process

Specified by:

getImageType in interface DescribeRegionPoint<T extends boofcv.struct.image.ImageSingleBand,NccFeature>

Returns:

ImageDataType

getCanonicalWidth

public double getCanonicalWidth()

Description copied from interface: DescribeRegionPoint

Returns the width of the square (or approximation of) sample region at a scale of one. When multiplied by the scale, pixels outside of the square region should not influence the descriptor's value.

Specified by:

getCanonicalWidth in interface DescribeRegionPoint<T extends boofcv.struct.image.ImageSingleBand,NccFeature>

Returns:

width of descriptor at a scale of one

getDescriptionType

public java.lang.Class<NccFeature> getDescriptionType()

Description copied from interface: DescriptorInfo

The type of region descriptor generated

Specified by:

getDescriptionType in interface DescriptorInfo<NccFeature>

Returns:

Returns the descriptor type.