001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.analysis.algorithm.histogram;
031
032import org.openimaj.math.geometry.shape.Rectangle;
033import org.openimaj.math.statistics.distribution.Histogram;
034
035/**
036 * The primary purpose of this interface is to produce efficient access to
037 * (rectangular) histograms of arbitrary windows of an image. A number of
038 * methods are provided to extract such histograms.
039 * 
040 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
041 */
042public interface WindowedHistogramExtractor {
043
044        /**
045         * Get the number of bins
046         * 
047         * @return the number of bins
048         */
049        public abstract int getNumBins();
050
051        /**
052         * Compute the histogram for the given window.
053         * 
054         * @param roi
055         *            the window
056         * @return the histogram in the window of the last analysed image
057         */
058        public abstract Histogram computeHistogram(Rectangle roi);
059
060        /**
061         * Compute the histogram for the given window.
062         * 
063         * @param x
064         *            The x-coordinate of the top-left of the window
065         * @param y
066         *            The y-coordinate of the top-left of the window
067         * @param w
068         *            The width of the window
069         * @param h
070         *            The height of the window
071         * @return the histogram in the window of the last analysed image
072         */
073        public abstract Histogram computeHistogram(int x, int y, int w, int h);
074
075        /**
076         * Compute the histogram for the given window, storing the output in the
077         * given {@link Histogram} object, which must have the same length as given
078         * by {@link #getNumBins()}.
079         * 
080         * @param roi
081         *            the window
082         * @param histogram
083         *            the histogram to write to
084         */
085        public abstract void computeHistogram(Rectangle roi, Histogram histogram);
086
087        /**
088         * Compute the histogram for the given window, storing the output in the
089         * given {@link Histogram} object, which must have the same length as given
090         * by {@link #getNumBins()}.
091         * 
092         * @param x
093         *            The x-coordinate of the top-left of the window
094         * @param y
095         *            The y-coordinate of the top-left of the window
096         * @param w
097         *            The width of the window
098         * @param h
099         *            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}