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.util.Arrays;
033
034
035import org.kohsuke.args4j.CmdLineException;
036import org.kohsuke.args4j.CmdLineParser;
037import org.kohsuke.args4j.MBFImageOptionHandler;
038import org.kohsuke.args4j.Option;
039import org.kohsuke.args4j.ProxyOptionHandler;
040import org.openimaj.feature.ByteFV;
041import org.openimaj.feature.ByteFVComparison;
042import org.openimaj.feature.DoubleFV;
043import org.openimaj.feature.DoubleFVComparison;
044import org.openimaj.feature.FVComparator;
045import org.openimaj.feature.FeatureVector;
046import org.openimaj.feature.FloatFV;
047import org.openimaj.feature.FloatFVComparison;
048import org.openimaj.feature.IntFV;
049import org.openimaj.feature.IntFVComparison;
050import org.openimaj.feature.ShortFV;
051import org.openimaj.feature.ShortFVComparison;
052import org.openimaj.image.MBFImage;
053
054/**
055 * A tool for computing the similarities/distances between two images based
056 * on a global feature.
057 * 
058 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
059 *
060 */
061public class PairWiseComparisonTool {
062        @Option(name="--image-1", aliases="-im1", usage="first image", handler=MBFImageOptionHandler.class, required=true)
063        private MBFImage im1;
064        
065        @Option(name="--image-2", aliases="-im2", usage="second image", handler=MBFImageOptionHandler.class, required=true)
066        private MBFImage im2;
067        
068        @Option(name="--metric", aliases="-m", usage="comparison metric", required=true)
069        private FeatureComparison compare;
070        
071        @Option(name="--feature-type", aliases="-f", handler=ProxyOptionHandler.class, usage="Feature type", required=true)
072        private GlobalFeatureType feature;
073        private GlobalFeatureExtractor featureOp;
074        
075        @SuppressWarnings("unchecked")
076        protected <T extends FeatureVector> FVComparator<T> getComp(T fv, FeatureComparison type) {
077                if (fv instanceof ByteFV) return (FVComparator<T>) ByteFVComparison.valueOf(type.name());
078                if (fv instanceof ShortFV) return (FVComparator<T>) ShortFVComparison.valueOf(type.name());
079                if (fv instanceof IntFV) return (FVComparator<T>) IntFVComparison.valueOf(type.name());
080                if (fv instanceof FloatFV) return (FVComparator<T>) FloatFVComparison.valueOf(type.name());
081                if (fv instanceof DoubleFV) return (FVComparator<T>) DoubleFVComparison.valueOf(type.name());
082                return null;
083        }
084        
085        double execute() {
086                FeatureVector fv1 = featureOp.extract(im1);
087                FeatureVector fv2 = featureOp.extract(im2);
088                
089                if (compare == FeatureComparison.EQUALS) {
090                        if (Arrays.equals(fv1.asDoubleVector(), fv2.asDoubleVector()))
091                                return 1;
092                        return 0;
093                } else {
094                        return getComp(fv1, compare).compare(fv1, fv2);
095                }
096        }
097        
098        /**
099         * The main method of the tool.
100         * @param args
101         */
102        public static void main(String [] args) {
103                PairWiseComparisonTool tool = new PairWiseComparisonTool();
104                
105                CmdLineParser parser = new CmdLineParser(tool);
106
107                try {
108                        parser.parseArgument(args);
109                } catch (CmdLineException e) {
110                        System.err.println(e.getMessage());
111                        System.err.println("Usage: pairwisecomp [options...]");
112                        parser.printUsage(System.err);
113                        
114                        if (tool.feature == null) {
115                                for (GlobalFeatureType m : GlobalFeatureType.values()) {
116                                        System.err.println();
117                                        System.err.println(m + " options: ");
118                                        new CmdLineParser(m.getOptions()).printUsage(System.err);
119                                }
120                        }
121                        return;
122                }
123                
124                System.out.println(tool.execute());
125        }
126}