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.localfeature.options;
031
032import java.io.IOException;
033
034import org.kohsuke.args4j.Option;
035
036/**
037 * Options for the Extractor tool
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 */
041public class ExtractorOptions extends BaseExtractorOptions {
042        @Option(name = "--input", aliases = "-i", required = true, usage = "Input image file.", metaVar = "STRING")
043        private String input;
044
045        @Option(name = "--output", aliases = "-o", required = true, usage = "Output keypoint file.", metaVar = "STRING")
046        private String output;
047
048        /**
049         * Get the input location
050         * 
051         * @return the input location
052         */
053        public String getInput() {
054                return input;
055        }
056
057        /**
058         * Get the output location
059         * 
060         * @return the output location
061         */
062        public String getOutput() {
063                return output;
064        }
065
066        /**
067         * Read the input image as bytes
068         * 
069         * @return the input image as bytes
070         * @throws IOException
071         */
072        public byte[] getInputImage() throws IOException {
073                return getInputImage(input);
074        }
075}