DoGSIFTEngineOptions (OpenIMAJ master project 1.3.10 API)

java.lang.Object
- org.openimaj.image.analysis.pyramid.PyramidOptions<GaussianOctave<IMAGE>,IMAGE>
- - org.openimaj.image.analysis.pyramid.gaussian.GaussianPyramidOptions<IMAGE>
  - - org.openimaj.image.feature.local.engine.DoGSIFTEngineOptions<IMAGE>

Type Parameters:

IMAGE - Type of image processed by the Engine associated with these options.
```
public class DoGSIFTEngineOptions<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>
extends GaussianPyramidOptions<IMAGE>
```
Options for controlling SIFT feature localisation and extraction. Default values are based on Lowe's papers.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`eigenvalueRatio` The threshold on the ratio of the Eigenvalues of the Hessian matrix (Lowe IJCV, p.12)
`protected float`	`gaussianSigma` The width of the Gaussian used for weighting samples, relative to the half-width of the sampling window (default 1.0).
`protected float`	`magnificationFactor` The magnification factor determining the size of a spatial SIFT bin relative to the scale.
`protected float`	`magnitudeThreshold` Threshold on the magnitude of detected points (Lowe IJCV, p.11)
`protected int`	`numOriBins` The number of orientation bins (default 8)
`protected int`	`numOriHistBins` The number of orientation histogram bins for finding the dominant orientations; Lowe's IJCV paper (p.13) suggests 36 bins.
`protected int`	`numSpatialBins` The number of spatial bins in each direction (default 4)
`protected float`	`peakThreshold` Threshold for peak detection in the orientation histogram.
`protected float`	`samplingSize` The size of the sampling window relative to the sampling scale.
`protected float`	`scaling` The value for weighting the scaling Gaussian of the orientation histogram relative to the keypoint scale.
`protected int`	`smoothingIterations` The number of iterations of the smoothing filter.
`protected float`	`valueThreshold` Threshold for the maximum value allowed in the histogram (default 0.2)

Fields inherited from class org.openimaj.image.analysis.pyramid.gaussian.GaussianPyramidOptions
borderPixels, doubleInitialImage, extraScaleSteps, initialSigma, scales

Fields inherited from class org.openimaj.image.analysis.pyramid.PyramidOptions
keepOctaves, octaveProcessor, pyramidProcessor

Constructor Summary

Constructors
Constructor and Description

DoGSIFTEngineOptions()

Constructors
Constructor and Description
`DoGSIFTEngineOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getEigenvalueRatio()` Get the threshold on the ratio of the Eigenvalues of the Hessian matrix (Lowe IJCV, p.12)
`float`	`getGaussianSigma()` Get the width of the Gaussian used for weighting samples, relative to the half-width of the sampling window (default 1.0).
`float`	`getMagnificationFactor()` Get the magnification factor determining the size of a spatial SIFT bin relative to the scale.
`float`	`getMagnitudeThreshold()` Get the threshold on the magnitude of detected points (Lowe IJCV, p.11)
`int`	`getNumOriBins()` Get the number of orientation bins (default 8) in the SIFT feature
`int`	`getNumOriHistBins()` Get the number of orientation histogram bins for finding the dominant orientations; Lowe's IJCV paper (p.13) suggests 36 bins.
`int`	`getNumSpatialBins()` Get the number of spatial bins in each direction (default 4) in the SIFT feature
`float`	`getPeakThreshold()` Get the threshold for peak detection in the orientation histogram.
`float`	`getSamplingSize()` Get the size of the sampling window relative to the sampling scale.
`float`	`getScaling()` Get the value for weighting the scaling Gaussian of the orientation histogram relative to the keypoint scale.
`int`	`getSmoothingIterations()` Get the number of iterations of the smoothing filter.
`float`	`getValueThreshold()` Get the threshold for the maximum value allowed in the histogram (default 0.2)
`void`	`setEigenvalueRatio(float eigenvalueRatio)` Set the threshold on the ratio of the Eigenvalues of the Hessian matrix (Lowe IJCV, p.12)
`void`	`setGaussianSigma(float gaussianSigma)` Get the width of the Gaussian used for weighting samples, relative to the half-width of the sampling window (default 1.0).
`void`	`setMagnificationFactor(float magnificationFactor)` Set the magnification factor determining the size of a spatial SIFT bin relative to the scale.
`void`	`setMagnitudeThreshold(float magnitudeThreshold)` Set the threshold on the magnitude of detected points (Lowe IJCV, p.11)
`void`	`setNumOriBins(int numOriBins)` Set the number of orientation bins (default 8) in the SIFT feature
`void`	`setNumOriHistBins(int numOriHistBins)` Set the number of orientation histogram bins for finding the dominant orientations; Lowe's IJCV paper (p.13) suggests 36 bins.
`void`	`setNumSpatialBins(int numSpatialBins)` Set the number of spatial bins in each direction (default 4) in the SIFT feature
`void`	`setPeakThreshold(float peakThreshold)` Set the threshold for peak detection in the orientation histogram.
`void`	`setSamplingSize(float samplingSize)` Set the size of the sampling window relative to the sampling scale.
`void`	`setScaling(float scaling)` Set the value for weighting the scaling Gaussian of the orientation histogram relative to the keypoint scale.
`void`	`setSmoothingIterations(int smoothingIterations)` Set the number of iterations of the smoothing filter.
`void`	`setValueThreshold(float valueThreshold)` Set the threshold for the maximum value allowed in the histogram (default 0.2)

Methods inherited from class org.openimaj.image.analysis.pyramid.gaussian.GaussianPyramidOptions
createGaussianBlur, getBorderPixels, getExtraScaleSteps, getInitialSigma, getScales, isDoubleInitialImage, setBorderPixels, setDoubleInitialImage, setExtraScaleSteps, setInitialSigma, setScales

Methods inherited from class org.openimaj.image.analysis.pyramid.PyramidOptions
getOctaveProcessor, getPyramidProcessor, isKeepOctaves, setKeepOctaves, setOctaveProcessor, setPyramidProcessor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - eigenvalueRatio
```
protected float eigenvalueRatio
```
    The threshold on the ratio of the Eigenvalues of the Hessian matrix (Lowe IJCV, p.12)
  - magnitudeThreshold
```
protected float magnitudeThreshold
```
    Threshold on the magnitude of detected points (Lowe IJCV, p.11)
  - magnificationFactor
```
protected float magnificationFactor
```
    The magnification factor determining the size of a spatial SIFT bin relative to the scale. The overall sampling size is related to the number of spatial bins.
  - peakThreshold
```
protected float peakThreshold
```
    Threshold for peak detection in the orientation histogram. A value of 1.0 would result in only a single peak being detected.
  - numOriHistBins
```
protected int numOriHistBins
```
    The number of orientation histogram bins for finding the dominant orientations; Lowe's IJCV paper (p.13) suggests 36 bins.
  - scaling
```
protected float scaling
```
    The value for weighting the scaling Gaussian of the orientation histogram relative to the keypoint scale. Lowe's IJCV paper (p.13) suggests 1.5.
  - smoothingIterations
```
protected int smoothingIterations
```
    The number of iterations of the smoothing filter. The vlfeat SIFT implementation uses 6.
  - samplingSize
```
protected float samplingSize
```
    The size of the sampling window relative to the sampling scale. Lowe's ICCV paper suggests 3;
  - numOriBins
```
protected int numOriBins
```
    The number of orientation bins (default 8)
  - numSpatialBins
```
protected int numSpatialBins
```
    The number of spatial bins in each direction (default 4)
  - valueThreshold
```
protected float valueThreshold
```
    Threshold for the maximum value allowed in the histogram (default 0.2)
  - gaussianSigma
```
protected float gaussianSigma
```
    The width of the Gaussian used for weighting samples, relative to the half-width of the sampling window (default 1.0).
- Constructor Detail
  - DoGSIFTEngineOptions
```
public DoGSIFTEngineOptions()
```
- Method Detail
  - getEigenvalueRatio
```
public float getEigenvalueRatio()
```
    Get the threshold on the ratio of the Eigenvalues of the Hessian matrix (Lowe IJCV, p.12)
    
    Returns:
    
    the eigenvalue ratio threshold
  - setEigenvalueRatio
```
public void setEigenvalueRatio(float eigenvalueRatio)
```
    Set the threshold on the ratio of the Eigenvalues of the Hessian matrix (Lowe IJCV, p.12)
    
    Parameters:
    
    eigenvalueRatio - the eigenvalueRatio to set
  - getMagnitudeThreshold
```
public float getMagnitudeThreshold()
```
    Get the threshold on the magnitude of detected points (Lowe IJCV, p.11)
    
    Returns:
    
    the magnitude threshold
  - setMagnitudeThreshold
```
public void setMagnitudeThreshold(float magnitudeThreshold)
```
    Set the threshold on the magnitude of detected points (Lowe IJCV, p.11)
    
    Parameters:
    
    magnitudeThreshold - the magnitude threshold to set
  - getMagnificationFactor
```
public float getMagnificationFactor()
```
    Get the magnification factor determining the size of a spatial SIFT bin relative to the scale. The overall sampling size is related to the number of spatial bins.
    
    Returns:
    
    the magnification factor
  - setMagnificationFactor
```
public void setMagnificationFactor(float magnificationFactor)
```
    Set the magnification factor determining the size of a spatial SIFT bin relative to the scale. The overall sampling size is related to the number of spatial bins.
    
    Parameters:
    
    magnificationFactor - the magnification factor to set
  - getPeakThreshold
```
public float getPeakThreshold()
```
    Get the threshold for peak detection in the orientation histogram. A value of 1.0 would result in only a single peak being detected.
    
    Returns:
    
    the peak detection threshold
  - setPeakThreshold
```
public void setPeakThreshold(float peakThreshold)
```
    Set the threshold for peak detection in the orientation histogram. A value of 1.0 would result in only a single peak being detected.
    
    Parameters:
    
    peakThreshold - the peak detection threshold to set
  - getNumOriHistBins
```
public int getNumOriHistBins()
```
    Get the number of orientation histogram bins for finding the dominant orientations; Lowe's IJCV paper (p.13) suggests 36 bins.
    
    Returns:
    
    the number of orientation histogram bins
  - setNumOriHistBins
```
public void setNumOriHistBins(int numOriHistBins)
```
    Set the number of orientation histogram bins for finding the dominant orientations; Lowe's IJCV paper (p.13) suggests 36 bins.
    
    Parameters:
    
    numOriHistBins - the number of orientation histogram bins to set
  - getScaling
```
public float getScaling()
```
    Get the value for weighting the scaling Gaussian of the orientation histogram relative to the keypoint scale. Lowe's IJCV paper (p.13) suggests 1.5.
    
    Returns:
    
    the scaling amount
  - setScaling
```
public void setScaling(float scaling)
```
    Set the value for weighting the scaling Gaussian of the orientation histogram relative to the keypoint scale. Lowe's IJCV paper (p.13) suggests 1.5.
    
    Parameters:
    
    scaling - the scaling amount to set
  - getSmoothingIterations
```
public int getSmoothingIterations()
```
    Get the number of iterations of the smoothing filter. The vlfeat SIFT implementation uses 6.
    
    Returns:
    
    the number of smoothing iterations
  - setSmoothingIterations
```
public void setSmoothingIterations(int smoothingIterations)
```
    Set the number of iterations of the smoothing filter. The vlfeat SIFT implementation uses 6.
    
    Parameters:
    
    smoothingIterations - the number of smoothing iterations to set
  - getSamplingSize
```
public float getSamplingSize()
```
    Get the size of the sampling window relative to the sampling scale. Lowe's ICCV paper suggests 3;
    
    Returns:
    
    the sampling size
  - setSamplingSize
```
public void setSamplingSize(float samplingSize)
```
    Set the size of the sampling window relative to the sampling scale. Lowe's ICCV paper suggests 3;
    
    Parameters:
    
    samplingSize - the sampling size to set
  - getNumOriBins
```
public int getNumOriBins()
```
    Get the number of orientation bins (default 8) in the SIFT feature
    
    Returns:
    
    the number of orientation bins
  - setNumOriBins
```
public void setNumOriBins(int numOriBins)
```
    Set the number of orientation bins (default 8) in the SIFT feature
    
    Parameters:
    
    numOriBins - the number of orientation bins to set
  - getNumSpatialBins
```
public int getNumSpatialBins()
```
    Get the number of spatial bins in each direction (default 4) in the SIFT feature
    
    Returns:
    
    the number of spatial bins
  - setNumSpatialBins
```
public void setNumSpatialBins(int numSpatialBins)
```
    Set the number of spatial bins in each direction (default 4) in the SIFT feature
    
    Parameters:
    
    numSpatialBins - the number of spatial bins to set
  - getValueThreshold
```
public float getValueThreshold()
```
    Get the threshold for the maximum value allowed in the histogram (default 0.2)
    
    Returns:
    
    the threshold
  - setValueThreshold
```
public void setValueThreshold(float valueThreshold)
```
    Set the threshold for the maximum value allowed in the histogram (default 0.2)
    
    Parameters:
    
    valueThreshold - the threshold to set
  - getGaussianSigma
```
public float getGaussianSigma()
```
    Get the width of the Gaussian used for weighting samples, relative to the half-width of the sampling window (default 1.0).
    
    Returns:
    
    the Gaussian width
  - setGaussianSigma
```
public void setGaussianSigma(float gaussianSigma)
```
    Get the width of the Gaussian used for weighting samples, relative to the half-width of the sampling window (default 1.0).
    
    Parameters:
    
    gaussianSigma - the Gaussian width to set

Class DoGSIFTEngineOptions<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>

Field Summary

Fields inherited from class org.openimaj.image.analysis.pyramid.gaussian.GaussianPyramidOptions

Fields inherited from class org.openimaj.image.analysis.pyramid.PyramidOptions

Constructor Summary

Method Summary

Methods inherited from class org.openimaj.image.analysis.pyramid.gaussian.GaussianPyramidOptions

Methods inherited from class org.openimaj.image.analysis.pyramid.PyramidOptions

Methods inherited from class java.lang.Object

Field Detail

eigenvalueRatio

magnitudeThreshold

magnificationFactor

peakThreshold

numOriHistBins

scaling

smoothingIterations

samplingSize

numOriBins

numSpatialBins

valueThreshold

gaussianSigma

Constructor Detail

DoGSIFTEngineOptions

Method Detail

getEigenvalueRatio

setEigenvalueRatio

getMagnitudeThreshold

setMagnitudeThreshold

getMagnificationFactor

setMagnificationFactor

getPeakThreshold

setPeakThreshold

getNumOriHistBins

setNumOriHistBins

getScaling

setScaling

getSmoothingIterations

setSmoothingIterations

getSamplingSize

setSamplingSize

getNumOriBins

setNumOriBins

getNumSpatialBins

setNumSpatialBins

getValueThreshold

setValueThreshold

getGaussianSigma

setGaussianSigma