org.openimaj.video.processing.tracking.ObjectTracker Maven / Gradle / Ivy

Go to download
/**
 * 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.video.processing.tracking;

import java.util.List;

import org.openimaj.math.geometry.shape.Rectangle;

/**
 *	An interface for classes that can track objects in video (or image streams).
 *
 *	@author David Dupplaw ([email protected])
 *	
 *	@created 14 Oct 2011
 *
 *	@param  The type of objects that will be tracked 
 *	@param  The type of image in which the objects will be tracked
 */
public interface ObjectTracker
{
	/**
	 *	Initialise the tracking with the given target area in the given image.
	 *  
	 *	@param bounds The target area to track in the image
	 *	@param image The image to initialise the tracking with
	 *	@return A list of found objects (may be empty if no object found);
	 *		should not be null.
	 */
	public List initialiseTracking( Rectangle bounds, I image );

	/**
	 * 	Track the object in the image.
	 *  
	 *	@param image The image to continue tracking the object within.
	 *	@return The list of objects found in the image
	 */
	public List trackObject( I image );
	
}