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 package org.openimaj.image.model.landmark;
31
32 import org.openimaj.image.Image;
33 import org.openimaj.math.geometry.point.Point2d;
34 import org.openimaj.math.geometry.point.PointList;
35 import org.openimaj.util.pair.ObjectFloatPair;
36
37 /**
38 * A {@link LandmarkModel} models local image content and provides functionality
39 * to move a point in an image to a nearby point with a lower cost than at the
40 * initial point.
41 * <p>
42 * Landmarks are normally associated with points in {@link PointList}s and thus
43 * quite often have an associated "intrinsic scale". This scale can be used to
44 * dynamically change the size of the support region of a landmark so that is
45 * scales with the {@link PointList}s intrinsic scale.
46 *
47 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
48 *
49 * @param <I>
50 * Type of image
51 */
52 public interface LandmarkModel<I extends Image<?, I>> {
53 /**
54 * Update the internal model of local image content by adding information
55 * from the provided image.
56 *
57 * @param image
58 * the image
59 * @param point
60 * the point in the image representing the landmark
61 * @param pointList
62 * the pointList to which the point belongs
63 */
64 public void updateModel(I image, Point2d point, PointList pointList);
65
66 /**
67 * Evaluate the cost function using the given image and point. Lower costs
68 * indicate better fits.
69 *
70 * @param image
71 * the image
72 * @param point
73 * the point in the image
74 * @param pointList
75 * the pointList to which the point belongs
76 * @return the cost
77 */
78 public float computeCost(I image, Point2d point, PointList pointList);
79
80 /**
81 * Estimate an improved fit based on a local neighbourhood search. Returns
82 * the new best point and the distance moved normalised by the size of the
83 * search area. If the point didn't move, then the distance would be 0; if
84 * the point moved to the extremity of the search region, it would be 1.0.
85 *
86 * @param image
87 * the image
88 * @param initial
89 * the initial point in the image
90 * @param pointList
91 * the pointList to which the point belongs
92 * @return the updated point
93 */
94 public ObjectFloatPair<Point2d> updatePosition(I image, Point2d initial, PointList pointList);
95 }