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.io.File;
033import java.io.IOException;
034import java.net.URL;
035
036import org.apache.commons.io.FileUtils;
037import org.openimaj.data.DataUtils;
038import org.openimaj.experiment.annotations.DatasetDescription;
039import org.openimaj.image.Image;
040import org.openimaj.io.InputStreamObjectReader;
041
042/**
043 * Tim Cootes's sample appearance modelling data
044 * 
045 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
046 */
047@DatasetDescription(
048                name = "Tim Cootes's sample appearance modelling data",
049                description = "The sample data (images, points and connections) that come with Tim Cootes's am_tools software.",
050                creator = "Tim Cootes",
051                url = "http://www.isbe.man.ac.uk/~bim/software/am_tools_doc/",
052                downloadUrls = {
053                                "http://datasets.openimaj.org/am_tools_data.zip"
054                })
055public class AMToolsSampleDataset {
056        private static final String DATA_ZIP = "am_tools_data.zip";
057        private static final String DATA_DOWNLOAD_URL = "http://datasets.openimaj.org/am_tools_data.zip";
058
059        /**
060         * Get a dataset of the IMM images and points. If the dataset hasn't been
061         * downloaded, it will be fetched automatically and stored in the OpenIMAJ
062         * data directory. The images in the dataset are grouped by their class.
063         * 
064         * @see DataUtils#getDataDirectory()
065         * 
066         * @param reader
067         *            the reader for images (can be <code>null</code> if you only
068         *            care about the points)
069         * @return the dataset
070         * @throws IOException
071         *             if an error occurs
072         */
073        public static <IMAGE extends Image<?, IMAGE>> ShapeModelDataset<IMAGE> load(InputStreamObjectReader<IMAGE> reader)
074                        throws IOException
075        {
076                final String basePath = downloadAndGetPath();
077                return ShapeModelDatasets.loadPTSDataset(basePath + "points/", basePath + "images/", basePath
078                                + "models/face.parts", reader);
079        }
080
081        private static String downloadAndGetPath() throws IOException {
082                final File dataset = DataUtils.getDataLocation(DATA_ZIP);
083
084                if (!(dataset.exists())) {
085                        dataset.getParentFile().mkdirs();
086                        FileUtils.copyURLToFile(new URL(DATA_DOWNLOAD_URL), dataset);
087                }
088
089                return "zip:file:" + dataset.toString() + "!am_tools_data/";
090        }
091
092}