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.examples.image.feature.local;
031
032import java.io.IOException;
033
034import org.openimaj.OpenIMAJ;
035import org.openimaj.feature.local.list.LocalFeatureList;
036import org.openimaj.image.FImage;
037import org.openimaj.image.ImageUtilities;
038import org.openimaj.image.feature.local.engine.DoGSIFTEngine;
039import org.openimaj.image.feature.local.keypoints.Keypoint;
040import org.openimaj.io.IOUtils;
041
042/**
043 * Example showing how to extract SIFT features from an image and write them to
044 * {@link System#out} in a format compatible with David Lowe's <a
045 * href="http://www.cs.ubc.ca/~lowe/keypoints/">keypoint</a> tool.
046 * 
047 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
048 */
049public class BasicSIFTExtractionExample {
050        /**
051         * Main method
052         * 
053         * @param args
054         *            ignored
055         * @throws IOException
056         *             if the image can't be read
057         */
058        public static void main(String[] args) throws IOException {
059                // read an image
060                final FImage image = ImageUtilities.readF(OpenIMAJ.getLogoAsStream());
061
062                // create the extractor - this can be reused (and is thread-safe)
063                final DoGSIFTEngine engine = new DoGSIFTEngine();
064
065                // find interest points in the image and extract SIFT descriptors
066                final LocalFeatureList<Keypoint> keypoints = engine.findFeatures(image);
067
068                // print the interest points to stdout
069                IOUtils.writeASCII(System.out, keypoints);
070        }
071}