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

Class SimpleBlockStrategy

java.lang.Object

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

All Implemented Interfaces:

SpatialBinningStrategy

public class SimpleBlockStrategy
extends Object
implements SpatialBinningStrategy

A SpatialBinningStrategy that extracts histograms from a number of equally-sized, non-overlapping within the sample region and concatenates them together. Each sub-histogram is L2 normalised.

Author:

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

Constructor Summary

Constructors

Constructor and Description
SimpleBlockStrategy(int numBlocks) Construct with the given number of blocks in both the x and y directions.
SimpleBlockStrategy(int numBlocksX, int numBlocksY) Construct with the given number of blocks in the x and y directions.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBlockStrategy

public SimpleBlockStrategy(int numBlocks)

Construct with the given number of blocks in both the x and y directions.

Parameters:

numBlocks - number of blocks in each direction

SimpleBlockStrategy

public SimpleBlockStrategy(int numBlocksX,
                           int numBlocksY)

Construct with the given number of blocks in the x and y directions.

Parameters:

numBlocksX - number of blocks in the x directions

numBlocksY - number of blocks in the y directions

Method Detail

extract

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

Description copied from interface: SpatialBinningStrategy

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);
 

Specified by:

extract in interface SpatialBinningStrategy

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)