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 java.util.List;
033
034import org.openimaj.image.Image;
035import org.openimaj.image.objectdetection.filtering.DetectionFilter;
036import org.openimaj.math.geometry.shape.Rectangle;
037
038/**
039 * An {@link ObjectDetector} that wraps another {@link ObjectDetector} and
040 * performs filtering with a {@link DetectionFilter}.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 * 
044 * @param <IMAGE>
045 *            Type of image in which the detection happens
046 * @param <DETECTED_OBJECT>
047 *            The type of object emitted by the inner detector
048 * @param <FILTERED_OBJECT>
049 *            The type of object emitted by the filter
050 */
051public class FilteringObjectDetector<IMAGE extends Image<?, IMAGE>, DETECTED_OBJECT, FILTERED_OBJECT>
052                implements
053                ObjectDetector<IMAGE, FILTERED_OBJECT>
054{
055        private ObjectDetector<IMAGE, DETECTED_OBJECT> detector;
056        private DetectionFilter<DETECTED_OBJECT, FILTERED_OBJECT> filter;
057
058        /**
059         * Construct with the given detector and filter.
060         * 
061         * @param detector
062         *            the detector
063         * @param filter
064         *            the filter
065         */
066        public FilteringObjectDetector(ObjectDetector<IMAGE, DETECTED_OBJECT> detector,
067                        DetectionFilter<DETECTED_OBJECT, FILTERED_OBJECT> filter)
068        {
069                super();
070                this.detector = detector;
071                this.filter = filter;
072        }
073
074        @Override
075        public List<FILTERED_OBJECT> detect(IMAGE image) {
076                return filter.apply(detector.detect(image));
077        }
078
079        @Override
080        public void setROI(Rectangle roi) {
081                detector.setROI(roi);
082        }
083}