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.objectdetection.haar;
031
032import org.openimaj.image.analysis.algorithm.SummedSqTiltAreaTable;
033
034/**
035 * Interface for an individual Haar-like classifier.
036 * 
037 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
038 * 
039 */
040public interface Classifier {
041        /**
042         * Get the classification score for the window at (x, y) with the size
043         * defined by scale.
044         * 
045         * @param sat
046         *            the summed area tables (integral images)
047         * @param wvNorm
048         *            the normalisation based on the current window variance
049         * @param x
050         *            the x-ordinate of the top-left of the window being tested
051         * @param y
052         *            the y-ordinate of the top-left of the window being tested
053         * @return the classification score
054         */
055        public float classify(final SummedSqTiltAreaTable sat, final float wvNorm, final int x, final int y);
056
057        /**
058         * Update the caches for a given scale (given by the
059         * <code>cachedScale</code> of the {@link StageTreeClassifier}).
060         * 
061         * @param cascade
062         *            the tree of stages
063         */
064        void updateCaches(StageTreeClassifier cascade);
065}