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;
034
035import java.io.File;
036
037import org.kohsuke.args4j.Option;
038
039/**
040 *  @author David Dupplaw (dpd@ecs.soton.ac.uk)
041 *      
042 *      @created 30 May 2011
043 */
044public class FaceSimilarityToolOptions extends FaceToolOptions
045{
046        @Option(name="-w",aliases="--withFirst",usage="Match against first rather than with all")
047        boolean withFirst = false;
048        
049        @Option(name="-bb",usage="Output bounding boxes of detected faces" )
050        boolean boundingBoxes = false;
051        
052        @Option(required=false,name="-s",aliases="--strategy",usage="The facial similarity strategy")
053        PredefinedStrategy strategy = PredefinedStrategy.FACEPATCH_EUCLIDEAN;
054        
055        @Option(required=false,name="-o",aliases="--output",usage="If desired, output the similarity matrix to a file")
056        File output = null;
057        
058        @Option(required=false,name="-c",aliases="--cache",usage="If desired, output the similarity matrix to a file")
059        boolean cache = true;
060        
061        @Option(required=false,name="-v",aliases="--invert",usage="If the scores are distances, invert them into similarities")
062        boolean invertIfRequired = false;
063}