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 */
030/**
031 * 
032 */
033package org.openimaj.tools.faces.extraction;
034
035import org.kohsuke.args4j.Option;
036
037/**
038 *      Command-line option class for the face extractor tool.
039 * 
040 *  @author David Dupplaw (dpd@ecs.soton.ac.uk)
041 *      
042 *      @created 7 Nov 2011
043 */
044public class FaceExtractorToolOptions
045{
046        /** The video file to process */
047        @Option(name="-v",aliases="--video",usage="Video File",required=true)
048        public String videoFile = null;
049        
050        /** The directory to which all faces will be extracted */
051        @Option(name="-o",aliases="--output",usage="Output Directory",required=true)
052        public String outputFile = null;
053        
054        /** Whether to output verbose progress to the stdout */
055        @Option(name="--verbose",usage="Verbose Output",required=false)
056        public boolean verbose = false;
057        
058        /** How often to take a face test */
059        @Option(name="-s",usage="Face Test Period",required=false)
060        public int seconds = 2;
061        
062        /** Whether to use the centre frame (as opposed to doing face tests) */
063        @Option(name="-c",aliases="--centre",usage="Use Centre Frame",required=false)
064        public boolean useCentre = false;
065        
066        /** Whether to write the face image or not */
067        @Option(name="-f",aliases="--face",usage="Write Face Images",required=false)
068        public boolean writeFaceImage = false;
069        
070        /** Whether to write the frames in which the faces are found */
071        @Option(name="-vf",aliases="--frame",usage="Write Frame Image",required=false)
072        public boolean writeFrameImage = false;
073        
074        /** Whether to write XML information about the found faces */
075        @Option(name="-x",aliases="--xml",usage="Write XML info for faces",required=false)
076        public boolean writeXML = false;
077        
078        /** The shot differential threshold to use for the shot boundary detector */
079        @Option(name="-t",aliases="--threshold",usage="Set Shot Boundary Threshold",required=false)
080        public double threshold = 5000;
081        
082        /** The minimum face size for the face detector */
083        @Option(name="-m",aliases="--minFaceSize",usage="Set the Minimum Face Size",required=false)
084        public int faceSize = 40;
085}