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.asm.datasets;
31
32 import java.util.List;
33
34 import org.openimaj.data.dataset.ListDataset;
35 import org.openimaj.image.Image;
36 import org.openimaj.image.model.asm.ActiveShapeModel;
37 import org.openimaj.math.geometry.point.PointList;
38 import org.openimaj.math.geometry.point.PointListConnections;
39 import org.openimaj.math.geometry.shape.PointDistributionModel;
40 import org.openimaj.util.pair.IndependentPair;
41
42 /**
43 * Dataset representing pairs of images and fixed size sets of points, together
44 * with a set of connections between points which are valid across all
45 * instances. Useful for training {@link PointDistributionModel}s and
46 * {@link ActiveShapeModel}s.
47 *
48 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
49 *
50 * @param <IMAGE>
51 * type of the images in the collection
52 */
53 public interface ShapeModelDataset<IMAGE extends Image<?, IMAGE>>
54 extends
55 ListDataset<IndependentPair<PointList, IMAGE>>
56 {
57 /**
58 * Get the connections between the points
59 *
60 * @return the connections
61 */
62 public PointListConnections getConnections();
63
64 /**
65 * Get the points for each instance
66 *
67 * @return the point list for each instance
68 */
69 public List<PointList> getPointLists();
70
71 /**
72 * Get the image for each instance
73 *
74 * @return the image for each instance
75 */
76 public List<IMAGE> getImages();
77 }