1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 /**
31 *
32 */
33 package org.openimaj.video.processing.tracking;
34
35 import java.util.List;
36
37 import org.openimaj.math.geometry.shape.Rectangle;
38
39 /**
40 * An interface for classes that can track objects in video (or image streams).
41 *
42 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
43 *
44 * @created 14 Oct 2011
45 *
46 * @param <O> The type of objects that will be tracked
47 * @param <I> The type of image in which the objects will be tracked
48 */
49 public interface ObjectTracker<O,I>
50 {
51 /**
52 * Initialise the tracking with the given target area in the given image.
53 *
54 * @param bounds The target area to track in the image
55 * @param image The image to initialise the tracking with
56 * @return A list of found objects (may be empty if no object found);
57 * should not be null.
58 */
59 public List<O> initialiseTracking( Rectangle bounds, I image );
60
61 /**
62 * Track the object in the image.
63 *
64 * @param image The image to continue tracking the object within.
65 * @return The list of objects found in the image
66 */
67 public List<O> trackObject( I image );
68
69 }