001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.model.asm.datasets;
031
032import java.util.List;
033
034import org.openimaj.data.dataset.ListDataset;
035import org.openimaj.image.Image;
036import org.openimaj.image.model.asm.ActiveShapeModel;
037import org.openimaj.math.geometry.point.PointList;
038import org.openimaj.math.geometry.point.PointListConnections;
039import org.openimaj.math.geometry.shape.PointDistributionModel;
040import org.openimaj.util.pair.IndependentPair;
041
042/**
043 * Dataset representing pairs of images and fixed size sets of points, together
044 * with a set of connections between points which are valid across all
045 * instances. Useful for training {@link PointDistributionModel}s and
046 * {@link ActiveShapeModel}s.
047 *
048 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
049 *
050 * @param <IMAGE>
051 *            type of the images in the collection
052 */
053public interface ShapeModelDataset<IMAGE extends Image<?, IMAGE>>
054extends
055ListDataset<IndependentPair<PointList, IMAGE>>
056{
057        /**
058         * Get the connections between the points
059         *
060         * @return the connections
061         */
062        public PointListConnections getConnections();
063
064        /**
065         * Get the points for each instance
066         *
067         * @return the point list for each instance
068         */
069        public List<PointList> getPointLists();
070
071        /**
072         * Get the image for each instance
073         *
074         * @return the image for each instance
075         */
076        public List<IMAGE> getImages();
077}