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.tools.globalfeature;
031
032import java.io.IOException;
033import java.io.OutputStream;
034
035import org.kohsuke.args4j.CmdLineException;
036import org.kohsuke.args4j.CmdLineParser;
037import org.kohsuke.args4j.FileOutputStreamOptionHandler;
038import org.kohsuke.args4j.MBFImageOptionHandler;
039import org.kohsuke.args4j.Option;
040import org.kohsuke.args4j.ProxyOptionHandler;
041import org.openimaj.feature.FeatureVector;
042import org.openimaj.image.MBFImage;
043import org.openimaj.io.IOUtils;
044
045/**
046 * A tool for extracting global image features.
047 * 
048 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
049 */
050public class GlobalFeaturesTool {
051        @Option(name="--feature-type", aliases="-f", handler=ProxyOptionHandler.class, usage="Feature type", required=true)
052        private GlobalFeatureType feature;
053        private GlobalFeatureExtractor featureOp;
054        
055        @Option(name = "-input", aliases="-i", required=true, usage="Set the input image", handler=MBFImageOptionHandler.class)
056        private MBFImage input;
057        
058        @Option(name = "-output", aliases="-o", required=false, usage="Set the output file; if not set then output is to stdout", handler=FileOutputStreamOptionHandler.class)
059        private OutputStream output = System.out;
060        
061        @Option(name = "--binary", aliases="-b", required=false, usage="Set output mode to binary")
062        private boolean binary = false;
063        
064        void execute() throws IOException {
065                FeatureVector fv = featureOp.extract(input);
066                
067                if (binary)
068                        IOUtils.writeBinary(output, fv);
069                else
070                        IOUtils.writeASCII(output, fv);
071        }
072        
073        /**
074         * The main method of the tool.
075         * 
076         * @param args
077         * @throws IOException
078         * @throws IllegalArgumentException
079         * @throws IllegalAccessException
080         */
081        public static void main(String [] args) throws IOException, IllegalArgumentException, IllegalAccessException {
082                GlobalFeaturesTool tool = new GlobalFeaturesTool();
083                
084                CmdLineParser parser = new CmdLineParser(tool);
085
086                try {
087                        parser.parseArgument(args);
088                } catch (CmdLineException e) {
089                        System.err.println(e.getMessage());
090                        System.err.println("Usage: java -jar GlobalFeaturesTool.jar [options...]");
091                        parser.printUsage(System.err);
092                        
093                        if (tool.feature == null) {
094                                for (GlobalFeatureType m : GlobalFeatureType.values()) {
095                                        System.err.println();
096                                        System.err.println(m + " options: ");
097                                        new CmdLineParser(m.getOptions()).printUsage(System.err);
098                                }
099                        }
100                        return;
101                }
102                
103                tool.execute();
104        }
105}