de.lmu.ifi.dbs.jfeaturelib.features

Class SURF

java.lang.Object

de.lmu.ifi.dbs.jfeaturelib.features.AbstractFeatureDescriptor

de.lmu.ifi.dbs.jfeaturelib.features.SURF

All Implemented Interfaces:

Descriptor, FeatureDescriptor

public class SURF
extends AbstractFeatureDescriptor

Wrapper for the ImageJ SURF plugin (http://www.labun.com/imagej-surf/)

Author:

Benedikt

Nested Class Summary

Nested classes/interfaces inherited from interface de.lmu.ifi.dbs.jfeaturelib.Descriptor

Descriptor.Supports

Field Summary

Fields inherited from class de.lmu.ifi.dbs.jfeaturelib.features.AbstractFeatureDescriptor

pcs

Fields inherited from interface de.lmu.ifi.dbs.jfeaturelib.Descriptor

DOES_ALL

Constructor Summary

Constructors

Constructor and Description
SURF() Empty default constructor
SURF(int octaves, int layers, float threshold, int initStep, boolean upright, boolean displayOrientationVectors, boolean displayDescriptorWindows, int lineWidth, boolean displayStatistics) Constructs a SURF instance with all params

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a short plain Text description about the Descriptor and the semantics of the double array obtained from FeatureDescriptor.getFeatures().
boolean	getDisplayDescriptorWindows()
boolean	getDisplayOrientationVectors()
boolean	getDisplayStatistics()
List<double[]>	getFeatures() Returns the list of SURF features.
int	getInitStep()
int	getLayers()
int	getLineWidth()
int	getOctaves()
Params	getParams()
float	getThreshold()
boolean	getUpright()
void	run(ij.process.ImageProcessor ip) Start processing of this algorithm on the given image processor.
void	setDisplayDescriptorWindows(boolean displayDescriptorWindows) Set if windows for each IP should be displayed
void	setDisplayOrientationVectors(boolean displayOrientationVectors) Set if line width should display IP strength
void	setDisplayStatistics(boolean displayStatistics) Sets if detailled statistics are displayed
void	setInitStep(int initStep) Set initial step param
void	setLayers(int layers) Set layers param
void	setLineWidth(int lineWidth) Set overall line width
void	setOctaves(int octaves) Set octaves param
void	setThreshold(float threshold) Set treshold param
void	setUpright(boolean upright) Set if rotation invariant should be excluded
EnumSet<Descriptor.Supports>	supports() Determine the capabilities of this algorithm.

Methods inherited from class de.lmu.ifi.dbs.jfeaturelib.features.AbstractFeatureDescriptor

addData, addData, addData, addPropertyChangeListener, endProgress, firePropertyChange, getMask, inMask, setMask, setProperties, startProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

SURF

public SURF()

Empty default constructor

SURF

public SURF(int octaves,
    int layers,
    float threshold,
    int initStep,
    boolean upright,
    boolean displayOrientationVectors,
    boolean displayDescriptorWindows,
    int lineWidth,
    boolean displayStatistics)

Constructs a SURF instance with all params

Parameters:

octaves -

layers -

threshold -

initStep -

upright -

displayOrientationVectors -

displayDescriptorWindows -

lineWidth -

displayStatistics -

Method Detail

getDescription

public String getDescription()

Description copied from interface: FeatureDescriptor

Returns a short plain Text description about the Descriptor and the semantics of the double array obtained from FeatureDescriptor.getFeatures(). May return null if no description is implemented - even though this should be avoided by any means.

Returns:

semantic description of getFeatures or null.

run

public void run(ij.process.ImageProcessor ip)

Description copied from interface: Descriptor

Start processing of this algorithm on the given image processor. Keep in mind that if the imageProcessor is changed, Supports.NoChanges must not be set. This is also the case even if only ImageProcessor.snapshot() is used.

getFeatures

public List<double[]> getFeatures()

Returns the list of SURF features. Each feature vector is composed as follows: poi.x, poi.y, poi.trace, poi.strength, poi.scale, poi.orientation, [feature vector]

Specified by:

getFeatures in interface FeatureDescriptor

Overrides:

getFeatures in class AbstractFeatureDescriptor

Returns:

list of vectors

supports

public EnumSet<Descriptor.Supports> supports()

Description copied from interface: Descriptor

Determine the capabilities of this algorithm.

Specified by:

supports in interface Descriptor

Overrides:

supports in class AbstractFeatureDescriptor

Returns:

the set of supported capabilities.

setOctaves

public void setOctaves(int octaves)

Set octaves param

Parameters:

octaves -

setLayers

public void setLayers(int layers)

Set layers param

Parameters:

layers -

setThreshold

public void setThreshold(float threshold)

Set treshold param

Parameters:

threshold -

setInitStep

public void setInitStep(int initStep)

Set initial step param

Parameters:

initStep -

setUpright

public void setUpright(boolean upright)

Set if rotation invariant should be excluded

Parameters:

upright -

setDisplayOrientationVectors

public void setDisplayOrientationVectors(boolean displayOrientationVectors)

Set if line width should display IP strength

Parameters:

displayOrientationVectors -

setDisplayDescriptorWindows

public void setDisplayDescriptorWindows(boolean displayDescriptorWindows)

Set if windows for each IP should be displayed

Parameters:

displayDescriptorWindows -

setLineWidth

public void setLineWidth(int lineWidth)

Set overall line width

Parameters:

lineWidth -

setDisplayStatistics

public void setDisplayStatistics(boolean displayStatistics)

Sets if detailled statistics are displayed

Parameters:

displayStatistics -

getOctaves

public int getOctaves()

Returns:

Number of octaves

getLayers

public int getLayers()

Returns:

number of layers

getThreshold

public float getThreshold()

Returns:

treshold

getInitStep

public int getInitStep()

Returns:

initial step

getUpright

public boolean getUpright()

Returns:

no rotation invariant

getDisplayOrientationVectors

public boolean getDisplayOrientationVectors()

Returns:

vector lines for each IP

getDisplayDescriptorWindows

public boolean getDisplayDescriptorWindows()

Returns:

windows for each IP

getLineWidth

public int getLineWidth()

Returns:

overall line width

getDisplayStatistics

public boolean getDisplayStatistics()

Returns:

detailled statistics

getParams

public Params getParams()

Returns:

Params object holding parameters