ColourDenseSIFT (OpenIMAJ master project 1.3.10 API)

java.lang.Object
- org.openimaj.image.feature.dense.gradient.dsift.AbstractDenseSIFT<MBFImage>
- - org.openimaj.image.feature.dense.gradient.dsift.ColourDenseSIFT

All Implemented Interfaces:

Cloneable, ImageAnalyser<MBFImage>
```
public class ColourDenseSIFT
extends AbstractDenseSIFT<MBFImage>
```
Implementation of colour dense-sift. The algorithm works by applying the DenseSIFT extractor to each channel of the image (in the target ColourSpace) and then aggregating the descriptors across all ColourSpaces for the same spatial location.
Any ColourSpace can be used. To compute the contrast energy of a descriptor, the luminance is extracted across channels using ColourSpace.computeIntensity(float[]). This means that if you choose a ColourSpace that doesn't support intensities, then the contrast energy will be zero. In practice this should not matter as it's most usual to use the ColourSpace.RGB, ColourSpace.HSV or ColourSpace.OPPONENT colour spaces, which can compute intensities.

Author:

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

Constructor Summary

Constructors
Constructor and Description
`ColourDenseSIFT(DenseSIFT dsift, ColourSpace colourSpace)` Construct with the given internal `DenseSIFT` extractor to apply to each band of the image created by converting the input to `#analyseImage(MBFImage)` or `analyseImage(MBFImage, Rectangle)` to the given `ColourSpace`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`analyseImage(MBFImage image, Rectangle bounds)` Compute the dense sift descriptors inside the bounds rectangle of the given image.
`int`	`getBinHeight()` (Optional operation) Get the height of a single bin of the sampling window (in pixels).
`int`	`getBinWidth()` (Optional operation) Get the width of a single bin of the sampling window (in pixels).
`LocalFeatureList<ByteDSIFTKeypoint>`	`getByteKeypoints()` Get the SIFT descriptors from the previous call to `AbstractDenseSIFT.analyseImage(Image)` or `AbstractDenseSIFT.analyseImage(Image, Rectangle)` in the form of a list of local features with byte vectors.
`LocalFeatureList<ByteDSIFTKeypoint>`	`getByteKeypoints(float energyThreshold)` Get the SIFT descriptors from the previous call to `AbstractDenseSIFT.analyseImage(Image)` or `AbstractDenseSIFT.analyseImage(Image, Rectangle)` in the form of a list of local features with byte vectors.
`float[][]`	`getDescriptors()` Get the computed raw dense SIFT descriptors from the previous call to `AbstractDenseSIFT.analyseImage(Image)` or `AbstractDenseSIFT.analyseImage(Image, Rectangle)` .
`LocalFeatureList<FloatDSIFTKeypoint>`	`getFloatKeypoints()` Get the SIFT descriptors from the previous call to `AbstractDenseSIFT.analyseImage(Image)` or `AbstractDenseSIFT.analyseImage(Image, Rectangle)` in the form of a list of local features with float vectors.
`LocalFeatureList<FloatDSIFTKeypoint>`	`getFloatKeypoints(float energyThreshold)` Get the SIFT descriptors from the previous call to `AbstractDenseSIFT.analyseImage(Image)` or `AbstractDenseSIFT.analyseImage(Image, Rectangle)` in the form of a list of local features with float vectors.
`int`	`getNumBinsX()` Get the number of spatial bins in the X direction
`int`	`getNumBinsY()` Get the number of spatial bins in the Y direction
`int`	`getNumOriBins()` Get the number of orientation bins
`void`	`setBinHeight(int size)` (Optional operation) Set the height of a single bin of the sampling window (in pixels).
`void`	`setBinWidth(int size)` (Optional operation) Set the width of a single bin of the sampling window (in pixels).

Methods inherited from class org.openimaj.image.feature.dense.gradient.dsift.AbstractDenseSIFT
analyseImage, clone

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

- Constructor Detail
  - ColourDenseSIFT
```
public ColourDenseSIFT(DenseSIFT dsift,
                       ColourSpace colourSpace)
```
    Construct with the given internal DenseSIFT extractor to apply to each band of the image created by converting the input to #analyseImage(MBFImage) or analyseImage(MBFImage, Rectangle) to the given ColourSpace.
    
    Parameters:
    
    dsift - the dense sift extractor
    
    colourSpace - the target colour space
- Method Detail
  - analyseImage
```
public void analyseImage(MBFImage image,
                         Rectangle bounds)
```
    Description copied from class: AbstractDenseSIFT
    
    Compute the dense sift descriptors inside the bounds rectangle of the given image.
    
    Specified by:
    
    analyseImage in class AbstractDenseSIFT<MBFImage>
    
    Parameters:
    
    image - the image
    
    bounds - the bounds rectangle
  - getFloatKeypoints
```
public LocalFeatureList<FloatDSIFTKeypoint> getFloatKeypoints()
```
    Description copied from class: AbstractDenseSIFT
    
    Get the SIFT descriptors from the previous call to AbstractDenseSIFT.analyseImage(Image) or AbstractDenseSIFT.analyseImage(Image, Rectangle) in the form of a list of local features with float vectors.
    
    Specified by:
    
    getFloatKeypoints in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    a list of FloatDSIFTKeypoints.
  - getByteKeypoints
```
public LocalFeatureList<ByteDSIFTKeypoint> getByteKeypoints()
```
    Description copied from class: AbstractDenseSIFT
    
    Get the SIFT descriptors from the previous call to AbstractDenseSIFT.analyseImage(Image) or AbstractDenseSIFT.analyseImage(Image, Rectangle) in the form of a list of local features with byte vectors.
    
    Specified by:
    
    getByteKeypoints in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    a list of ByteDSIFTKeypoints.
  - getFloatKeypoints
```
public LocalFeatureList<FloatDSIFTKeypoint> getFloatKeypoints(float energyThreshold)
```
    Description copied from class: AbstractDenseSIFT
    
    Get the SIFT descriptors from the previous call to AbstractDenseSIFT.analyseImage(Image) or AbstractDenseSIFT.analyseImage(Image, Rectangle) in the form of a list of local features with float vectors. Only the features with an energy above the given threshold will be returned.
    
    Specified by:
    
    getFloatKeypoints in class AbstractDenseSIFT<MBFImage>
    
    Parameters:
    
    energyThreshold - the threshold on the feature energy
    
    Returns:
    
    a list of FloatDSIFTKeypoints.
  - getByteKeypoints
```
public LocalFeatureList<ByteDSIFTKeypoint> getByteKeypoints(float energyThreshold)
```
    Description copied from class: AbstractDenseSIFT
    
    Get the SIFT descriptors from the previous call to AbstractDenseSIFT.analyseImage(Image) or AbstractDenseSIFT.analyseImage(Image, Rectangle) in the form of a list of local features with byte vectors. Only the features with an energy above the given threshold will be returned.
    
    Specified by:
    
    getByteKeypoints in class AbstractDenseSIFT<MBFImage>
    
    Parameters:
    
    energyThreshold - the threshold on the feature energy
    
    Returns:
    
    a list of ByteDSIFTKeypoints.
  - setBinWidth
```
public void setBinWidth(int size)
```
    Description copied from class: AbstractDenseSIFT
    
    (Optional operation) Set the width of a single bin of the sampling window (in pixels). Sampling window width is this multiplied by AbstractDenseSIFT.getNumBinsX().
    
    Specified by:
    
    setBinWidth in class AbstractDenseSIFT<MBFImage>
    
    Parameters:
    
    size - size to set
  - setBinHeight
```
public void setBinHeight(int size)
```
    Description copied from class: AbstractDenseSIFT
    
    (Optional operation) Set the height of a single bin of the sampling window (in pixels). Sampling window height is this multiplied by AbstractDenseSIFT.getNumBinsY().
    
    Specified by:
    
    setBinHeight in class AbstractDenseSIFT<MBFImage>
    
    Parameters:
    
    size - size to set
  - getBinWidth
```
public int getBinWidth()
```
    Description copied from class: AbstractDenseSIFT
    
    (Optional operation) Get the width of a single bin of the sampling window (in pixels). Sampling window width is this multiplied by AbstractDenseSIFT.getNumBinsX().
    
    Specified by:
    
    getBinWidth in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    the bin width
  - getBinHeight
```
public int getBinHeight()
```
    Description copied from class: AbstractDenseSIFT
    
    (Optional operation) Get the height of a single bin of the sampling window (in pixels). Sampling window height is this multiplied by AbstractDenseSIFT.getNumBinsY().
    
    Specified by:
    
    getBinHeight in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    the bin height
  - getNumBinsX
```
public int getNumBinsX()
```
    Description copied from class: AbstractDenseSIFT
    
    Get the number of spatial bins in the X direction
    
    Specified by:
    
    getNumBinsX in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    the number of bins in the x direction
  - getNumBinsY
```
public int getNumBinsY()
```
    Description copied from class: AbstractDenseSIFT
    
    Get the number of spatial bins in the Y direction
    
    Specified by:
    
    getNumBinsY in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    the number of bins in the y direction
  - getNumOriBins
```
public int getNumOriBins()
```
    Description copied from class: AbstractDenseSIFT
    
    Get the number of orientation bins
    
    Specified by:
    
    getNumOriBins in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    the number of orientation bins
  - getDescriptors
```
public float[][] getDescriptors()
```
    Description copied from class: AbstractDenseSIFT
    
    Get the computed raw dense SIFT descriptors from the previous call to AbstractDenseSIFT.analyseImage(Image) or AbstractDenseSIFT.analyseImage(Image, Rectangle) .
    
    Specified by:
    
    getDescriptors in class AbstractDenseSIFT<MBFImage>
    
    Returns:
    
    the descriptors.

Class ColourDenseSIFT

Constructor Summary

Method Summary

Methods inherited from class org.openimaj.image.feature.dense.gradient.dsift.AbstractDenseSIFT

Methods inherited from class java.lang.Object

Constructor Detail

ColourDenseSIFT

Method Detail

analyseImage

getFloatKeypoints

getByteKeypoints

getFloatKeypoints

getByteKeypoints

setBinWidth

setBinHeight

getBinWidth

getBinHeight

getNumBinsX

getNumBinsY

getNumOriBins

getDescriptors