org.openimaj.image.analysis.algorithm.histogram.binning

Interface SpatialBinningStrategy

All Known Implementing Classes:

FixedHOGStrategy, FlexibleHOGStrategy, QuadtreeStrategy, SimpleBlockStrategy

public interface SpatialBinningStrategy

Interface that describes the creation of a histogram from a spatial region of an image based on sub-histograms extracted using a WindowedHistogramExtractor.

Author:

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

Method Summary

Modifier and Type	Method and Description
Histogram	extract(WindowedHistogramExtractor binnedData, Rectangle region, Histogram output) Extract a histogram describing image content in the given region using the given WindowedHistogramExtractor to extract (sub) histograms from which to build the output.

Method Detail

extract

Histogram extract(WindowedHistogramExtractor binnedData,
                  Rectangle region,
                  Histogram output)

Extract a histogram describing image content in the given region using the given WindowedHistogramExtractor to extract (sub) histograms from which to build the output.

For efficiency, this method allows the output histogram to be specified as an input. This means that implementors of this interface can attempt to fill the output histogram rather than creating a new instance (although care should be taken to ensure that the porivded output histogram is the correct size and not null).

Users of SpatialBinningStrategys should use the following style for maximum efficiency:

 Histogram h = null;
 ...
 for (Rectangle region : lots_of_regions)
        h = strategy.extract(binnedData, region, h);
 

Parameters:

binnedData - the WindowedHistogramExtractor to extract sub-histograms from

region - the region to extract from

output - the output histogram to fill (can be null)

Returns:

the extracted histogram (preferably output)