boofcv.abst.feature.detdesc

Class DetectDescribeFusion<T extends ImageGray,TD extends TupleDesc>

java.lang.Object

boofcv.abst.feature.detdesc.DetectDescribeFusion<T,TD>

All Implemented Interfaces:

DescriptorInfo<TD>, DetectDescribePoint<T,TD>, FoundPointSO, InterestPointDetector<T>

public class DetectDescribeFusion<T extends ImageGray,TD extends TupleDesc>
extends java.lang.Object
implements DetectDescribePoint<T,TD>

Wrapper class around independent feature detectors, region orientation, and descriptors, that allow them to be used as a single integrated unit. Providing an algorithm for estimating orientation is optional. If one is provided, any orientation estimate provided by the detector is ignored.

See Also:

InterestPointDetector, OrientationImage, DescribeRegionPoint

Constructor Summary

Constructors

Constructor and Description
DetectDescribeFusion(InterestPointDetector<T> detector, OrientationImage<T> orientation, DescribeRegionPoint<T,TD> describe) Configures the algorithm.

Method Summary

Modifier and Type	Method and Description
TD	createDescription() Creates new description instance which can be processed by this class
void	detect(T input) Detects interest points inside the provided image.
TD	getDescription(int index) Returns the feature descriptor at the specified index.
java.lang.Class<TD>	getDescriptionType() The type of region descriptor generated
Point2D_F64	getLocation(int featureIndex) The center location of the feature inside the image.
int	getNumberOfFeatures() Returns the number of interest points found.
double	getOrientation(int featureIndex) Returns the features found orientation.
double	getRadius(int featureIndex) Returns the detected object's circular radius
boolean	hasOrientation() If the interest point detector estimates the feature's orientation
boolean	hasScale() Does the interest point detector have scale information

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectDescribeFusion

public DetectDescribeFusion(InterestPointDetector<T> detector,
                            OrientationImage<T> orientation,
                            DescribeRegionPoint<T,TD> describe)

Configures the algorithm.

Parameters:

detector - Feature detector

orientation - (Optional) orientation estimation algorithm

describe - Describes features

Method Detail

createDescription

public TD createDescription()

Description copied from interface: DescriptorInfo

Creates new description instance which can be processed by this class

Specified by:

createDescription in interface DescriptorInfo<TD extends TupleDesc>

Returns:

New descriptor

getDescription

public TD getDescription(int index)

Description copied from interface: DetectDescribePoint

Returns the feature descriptor at the specified index.

WARNING: The returned data structure is recycled each time InterestPointDetector.detect(boofcv.struct.image.ImageBase) is called. Create a copy if this is a problem.

Specified by:

getDescription in interface DetectDescribePoint<T extends ImageGray,TD extends TupleDesc>

Parameters:

index - Which feature

Returns:

Feature descriptor

getDescriptionType

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

Description copied from interface: DescriptorInfo

The type of region descriptor generated

Specified by:

getDescriptionType in interface DescriptorInfo<TD extends TupleDesc>

Returns:

Returns the descriptor type.

detect

public void detect(T input)

Description copied from interface: InterestPointDetector

Detects interest points inside the provided image.

Specified by:

detect in interface InterestPointDetector<T extends ImageGray>

Parameters:

input - Input features are detected inside of.

getNumberOfFeatures

public int getNumberOfFeatures()

Description copied from interface: FoundPointSO

Returns the number of interest points found.

Specified by:

getNumberOfFeatures in interface FoundPointSO

Returns:

Number of interest points.

getLocation

public Point2D_F64 getLocation(int featureIndex)

Description copied from interface: FoundPointSO

The center location of the feature inside the image.

WARNING: Do not save the returned reference, copy instead. The returned point can be recycled each time this function is called.

Specified by:

getLocation in interface FoundPointSO

Parameters:

featureIndex - The feature's index.

Returns:

Location of the feature in image pixels.

getRadius

public double getRadius(int featureIndex)

Description copied from interface: FoundPointSO

Returns the detected object's circular radius

Specified by:

getRadius in interface FoundPointSO

Parameters:

featureIndex - Feature whose radius is being requested.

Returns:

Object's radius

getOrientation

public double getOrientation(int featureIndex)

Description copied from interface: FoundPointSO

Returns the features found orientation.

Specified by:

getOrientation in interface FoundPointSO

Parameters:

featureIndex - Feature whose

Returns:

Orientation in radians.

hasScale

public boolean hasScale()

Description copied from interface: InterestPointDetector

Does the interest point detector have scale information

Specified by:

hasScale in interface InterestPointDetector<T extends ImageGray>

Returns:

true if it has scale information and false otherwise

hasOrientation

public boolean hasOrientation()

Description copied from interface: InterestPointDetector

If the interest point detector estimates the feature's orientation

Specified by:

hasOrientation in interface InterestPointDetector<T extends ImageGray>

Returns:

true if it estimates the orientation