org.openimaj.image.objectdetection.ObjectDetector Maven / Gradle / Ivy
/**
* Copyright (c) 2011, The University of Southampton and the individual contributors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the University of Southampton nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.openimaj.image.objectdetection;
import java.util.List;
import org.openimaj.image.Image;
import org.openimaj.image.objectdetection.filtering.DetectionFilter;
import org.openimaj.math.geometry.shape.Rectangle;
/**
* Interface describing a basic object detector for images. Any type of Java
* object can be used to represent a detection; this could be something as
* simple as a {@link Rectangle} representing the spatial location of the
* detection, or it could be much more complex.
*
* The interface allows for multiple detections to be returned from the input
* image. If required, these detections could be filtered by a
* {@link DetectionFilter} as a post-processing operation.
*
* This interface is implicitly for single-scale detection. If your detector
* works at multiple scales, then implementing the
* {@link MultiScaleObjectDetector} would be a better idea.
*
* @author Jonathon Hare ([email protected])
*
* @param
* The image on which to perform the detection
* @param
* the type of object representing a detection.
*/
public interface ObjectDetector, DETECTED_OBJECT> {
/**
* Detect objects in the given image and return representations of them.
* Representations often cover things like the spatial location in the image
* of the detected object, however, this is implementation defined.
*
* If no objects are detected, null or an empty list may be
* returned.
*
* @param image
* the image to detect the object in.
* @return a list of detections or null if none are found.
*/
public List detect(IMAGE image);
/**
* (Optional operation).
*
* Set the region of interest within the image to search for objects.
* Setting to null means to search the whole image.
*
* @param roi
* the region of interest
*/
public void setROI(Rectangle roi);
}