boofcv.abst.feature.describe

Interface DescribeRegionPoint<T extends ImageBase,Desc extends TupleDesc>

All Superinterfaces:

DescriptorInfo<Desc>

All Known Implementing Classes:

DescribeMultiSpectral, DescribeRegionPointConvert, SurfMultiSpectral_to_DescribeRegionPoint, WrapDescribeBrief, WrapDescribeBriefSo, WrapDescribePixelRegion, WrapDescribePixelRegionNCC, WrapDescribeSift, WrapDescribeSurf

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

Computes a description of the local region around a point. Scale sample regions size relative to an implementation specific standard. This if a region is sampled with a radius of 10 pixels at scale of one, it will be 25 pixels at a scale of 2.5. Orientation rotates the sample points. Exactly how and if scale and orientation are used is implementation specific.

Author:

Peter Abeles

Method Summary

Methods

Modifier and Type	Method and Description
ImageType<T>	getImageType() Description of the type of image it can process
boolean	process(double x, double y, double orientation, double scale, 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	requiresScale() 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 scale,
              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

scale - Scale at which the feature was found.

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

Returns:

true if a descriptor can computed or false if not.

requiresScale

boolean requiresScale()

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 scale information is used when computing the descriptor.

Returns:

if scale needs to be provided or 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