boofcv.alg.feature.describe

Class DescribeMultiSpectral<T extends boofcv.struct.image.ImageSingleBand,Desc extends TupleDesc>

java.lang.Object

boofcv.alg.feature.describe.DescribeMultiSpectral<T,Desc>

All Implemented Interfaces:

DescribeRegionPoint<boofcv.struct.image.MultiSpectral<T>,Desc>, DescriptorInfo<Desc>

public abstract class DescribeMultiSpectral<T extends boofcv.struct.image.ImageSingleBand,Desc extends TupleDesc>
extends java.lang.Object
implements DescribeRegionPoint<boofcv.struct.image.MultiSpectral<T>,Desc>

Computes a feature description from MultiSpectral images by computing a descriptor separately in each band. The output descriptor is computed by concatenating the descriptors for each bands together. So [1,2,3] and [3,4,5] from a two band image will become [1,2,3,3,4,5].

Constructor Summary

Constructors

Constructor and Description
DescribeMultiSpectral(DescribeRegionPoint<T,Desc>[] describers) Configuration

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	combine(Desc description) Given all the descriptors computed independently in each band, combine them together into a single descriptor.
java.lang.Class<Desc>	getDescriptionType() The type of region descriptor generated
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() True if the descriptor uses orientation information.
boolean	requiresScale() If scale information is used when computing the descriptor.
void	setImage(boofcv.struct.image.MultiSpectral<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

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

getImageType

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

createDescription

Constructor Detail

DescribeMultiSpectral

public DescribeMultiSpectral(DescribeRegionPoint<T,Desc>[] describers)

Configuration

Parameters:

describers - A descriptor for each band in the image.

Method Detail

setImage

public void setImage(boofcv.struct.image.MultiSpectral<T> image)

Description copied from interface: DescribeRegionPoint

Specified the image which is to be processed.

Specified by:

setImage in interface DescribeRegionPoint<boofcv.struct.image.MultiSpectral<T extends boofcv.struct.image.ImageSingleBand>,Desc extends TupleDesc>

Parameters:

image - The image which contains the features.

process

public boolean process(double x,
              double y,
              double orientation,
              double scale,
              Desc description)

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<boofcv.struct.image.MultiSpectral<T extends boofcv.struct.image.ImageSingleBand>,Desc extends TupleDesc>

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.

combine

protected abstract void combine(Desc description)

Given all the descriptors computed independently in each band, combine them together into a single descriptor.

Parameters:

description -

requiresScale

public boolean requiresScale()

Description copied from interface: DescribeRegionPoint

If scale information is used when computing the descriptor.

Specified by:

requiresScale in interface DescribeRegionPoint<boofcv.struct.image.MultiSpectral<T extends boofcv.struct.image.ImageSingleBand>,Desc extends TupleDesc>

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<boofcv.struct.image.MultiSpectral<T extends boofcv.struct.image.ImageSingleBand>,Desc extends TupleDesc>

Returns:

if orientation needs to be provided or not

getDescriptionType

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

Description copied from interface: DescriptorInfo

The type of region descriptor generated

Specified by:

getDescriptionType in interface DescriptorInfo<Desc extends TupleDesc>

Returns:

Returns the descriptor type.