1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package org.openimaj.image.analysis.algorithm.histogram.binning;
31
32 import org.openimaj.image.analysis.algorithm.histogram.WindowedHistogramExtractor;
33 import org.openimaj.math.geometry.shape.Rectangle;
34 import org.openimaj.math.statistics.distribution.Histogram;
35
36 /**
37 * Interface that describes the creation of a histogram from a spatial region of
38 * an image based on sub-histograms extracted using a
39 * {@link WindowedHistogramExtractor}.
40 *
41 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
42 */
43 public interface SpatialBinningStrategy {
44 /**
45 * Extract a histogram describing image content in the given region using
46 * the given {@link WindowedHistogramExtractor} to extract (sub) histograms
47 * from which to build the output.
48 * <p>
49 * For efficiency, this method allows the output histogram to be specified
50 * as an input. This means that implementors of this interface can attempt
51 * to fill the output histogram rather than creating a new instance
52 * (although care should be taken to ensure that the porivded output
53 * histogram is the correct size and not <code>null</code>).
54 * <p>
55 * Users of {@link SpatialBinningStrategy}s should use the following style
56 * for maximum efficiency: <code><pre>
57 * Histogram h = null;
58 * ...
59 * for (Rectangle region : lots_of_regions)
60 * h = strategy.extract(binnedData, region, h);
61 * </pre></code>
62 *
63 * @param binnedData
64 * the {@link WindowedHistogramExtractor} to extract
65 * sub-histograms from
66 * @param region
67 * the region to extract from
68 * @param output
69 * the output histogram to fill (can be null)
70 * @return the extracted histogram (preferably <code>output</code>)
71 */
72 public Histogram extract(WindowedHistogramExtractor binnedData, Rectangle region, Histogram output);
73 }