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;
31
32 import org.openimaj.math.geometry.shape.Rectangle;
33 import org.openimaj.math.statistics.distribution.Histogram;
34
35 /**
36 * The primary purpose of this interface is to produce efficient access to
37 * (rectangular) histograms of arbitrary windows of an image. A number of
38 * methods are provided to extract such histograms.
39 *
40 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
41 */
42 public interface WindowedHistogramExtractor {
43
44 /**
45 * Get the number of bins
46 *
47 * @return the number of bins
48 */
49 public abstract int getNumBins();
50
51 /**
52 * Compute the histogram for the given window.
53 *
54 * @param roi
55 * the window
56 * @return the histogram in the window of the last analysed image
57 */
58 public abstract Histogram computeHistogram(Rectangle roi);
59
60 /**
61 * Compute the histogram for the given window.
62 *
63 * @param x
64 * The x-coordinate of the top-left of the window
65 * @param y
66 * The y-coordinate of the top-left of the window
67 * @param w
68 * The width of the window
69 * @param h
70 * The height of the window
71 * @return the histogram in the window of the last analysed image
72 */
73 public abstract Histogram computeHistogram(int x, int y, int w, int h);
74
75 /**
76 * Compute the histogram for the given window, storing the output in the
77 * given {@link Histogram} object, which must have the same length as given
78 * by {@link #getNumBins()}.
79 *
80 * @param roi
81 * the window
82 * @param histogram
83 * the histogram to write to
84 */
85 public abstract void computeHistogram(Rectangle roi, Histogram histogram);
86
87 /**
88 * Compute the histogram for the given window, storing the output in the
89 * given {@link Histogram} object, which must have the same length as given
90 * by {@link #getNumBins()}.
91 *
92 * @param x
93 * The x-coordinate of the top-left of the window
94 * @param y
95 * The y-coordinate of the top-left of the window
96 * @param w
97 * The width of the window
98 * @param h
99 * The height of the window
100 * @param histogram
101 * the histogram to write to
102 */
103 public abstract void computeHistogram(int x, int y, int w, int h, Histogram histogram);
104 }