boofcv.abst.feature.describe

Interface DescribeRegionPoint<T extends ImageBase,Desc extends TupleDesc>

All Superinterfaces:

DescriptorInfo<Desc>

All Known Implementing Classes:

DescribePlanar, DescribeRegionPoint_SIFT, DescribeRegionPointConvert, SurfPlanar_to_DescribeRegionPoint, WrapDescribeBrief, WrapDescribeBriefSo, WrapDescribePixelRegion, WrapDescribePixelRegionNCC, WrapDescribeSurf

public interface DescribeRegionPoint<T extends ImageBase,Desc extends TupleDesc>
extends DescriptorInfo<Desc>

Computes a description of the local region around a point at different circular radii and orientations. The radius specifies the size of the object and it should be assumed to be circular in shape. Orientation rotates the sample points. Exactly how and if scale and orientation are used is implementation specific.

Method Summary

Modifier and Type	Method and Description
double	getCanonicalWidth() Returns the width of the square (or approximation of) sample region at a scale of one.
ImageType<T>	getImageType() Description of the type of image it can process
boolean	process(double x, double y, double orientation, double radius, Desc description) Extract a description of the local image at the given point, scale, and orientation.
boolean	requiresOrientation() Deprecated. Likely to be removed in the near future. if this flag is true or not won't change the input it gets when paired with InterestPointDetector
boolean	requiresRadius() Deprecated. Likely to be removed in the near future. if this flag is true or not won't change the input it gets when paired with InterestPointDetector
void	setImage(T image) Specified the image which is to be processed.

Methods inherited from interface boofcv.abst.feature.describe.DescriptorInfo

createDescription, getDescriptionType

Method Detail

setImage

void setImage(T image)

Specified the image which is to be processed.

Parameters:

image - The image which contains the features.

process

boolean process(double x,
                double y,
                double orientation,
                double radius,
                Desc description)

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.

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

radius - Radius of the detected object in pixels.

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

Returns:

true if a descriptor can computed or false if not.

requiresRadius

boolean requiresRadius()

Deprecated. Likely to be removed in the near future. if this flag is true or not won't change the input it gets when paired with InterestPointDetector

If size information is used when computing the descriptor.

Returns:

true is the radius is used when computing the descriptor or false if not

requiresOrientation

boolean requiresOrientation()

Deprecated. Likely to be removed in the near future. if this flag is true or not won't change the input it gets when paired with InterestPointDetector

True if the descriptor uses orientation information.

Returns:

if orientation needs to be provided or not

getImageType

ImageType<T> getImageType()

Description of the type of image it can process

Returns:

ImageDataType

getCanonicalWidth

double getCanonicalWidth()

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.

Returns:

width of descriptor at a scale of one