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;
031
032import org.openimaj.image.Image;
033import org.openimaj.math.geometry.shape.Rectangle;
034
035/**
036 * Abstract base class for implementations of {@link MultiScaleObjectDetector}.
037 * 
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 * 
040 * @param <IMAGE>
041 *            The image on which to perform the detection
042 * @param <DETECTED_OBJECT>
043 *            the type of object representing a detection.
044 */
045public abstract class AbstractMultiScaleObjectDetector<IMAGE extends Image<?, IMAGE>, DETECTED_OBJECT>
046                implements
047                        MultiScaleObjectDetector<IMAGE, DETECTED_OBJECT>
048{
049        protected Rectangle roi;
050        protected int minSize = 0;
051        protected int maxSize = 0;
052
053        /**
054         * Construct with the initial minimum and maximum size set to zero.
055         */
056        protected AbstractMultiScaleObjectDetector() {
057        }
058
059        /**
060         * Construct with the given initial minimum and maximum detection sizes.
061         * 
062         * @param minSize
063         *            minimum size
064         * @param maxSize
065         *            maximum size
066         */
067        protected AbstractMultiScaleObjectDetector(int minSize, int maxSize) {
068                this.minSize = minSize;
069                this.maxSize = maxSize;
070        }
071
072        @Override
073        public void setROI(Rectangle roi) {
074                this.roi = roi;
075        }
076
077        @Override
078        public void setMinimumDetectionSize(int size) {
079                this.minSize = size;
080        }
081
082        @Override
083        public void setMaximumDetectionSize(int size) {
084                this.maxSize = size;
085        }
086
087        @Override
088        public int getMinimumDetectionSize() {
089                return minSize;
090        }
091
092        @Override
093        public int getMaximumDetectionSize() {
094                return maxSize;
095        }
096}