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.similaritymatrix;
031
032
033import java.io.File;
034import java.io.IOException;
035
036import org.kohsuke.args4j.CmdLineOptionsProvider;
037import org.kohsuke.args4j.Option;
038import org.kohsuke.args4j.ProxyOptionHandler;
039import org.openimaj.io.IOUtils;
040import org.openimaj.math.matrix.similarity.SimilarityMatrix;
041import org.openimaj.math.matrix.similarity.processor.InvertData;
042import org.openimaj.tools.similaritymatrix.modes.Binarize;
043import org.openimaj.tools.similaritymatrix.modes.ConnectedComponents;
044import org.openimaj.tools.similaritymatrix.modes.DensestSubgraph;
045import org.openimaj.tools.similaritymatrix.modes.MDS;
046import org.openimaj.tools.similaritymatrix.modes.PrettyPrint;
047import org.openimaj.tools.similaritymatrix.modes.ToolMode;
048
049public class SimilarityMatrixToolOptions {
050        public enum Mode implements CmdLineOptionsProvider {
051                PRETTY_PRINT {
052                        @Override
053                        public ToolMode getOptions() {
054                                return new PrettyPrint();
055                        }
056                },
057                BINARIZE {
058                        @Override
059                        public ToolMode getOptions() {
060                                return new Binarize();
061                        }
062                },
063                DENSEST_SUBGRAPH {
064                        @Override
065                        public ToolMode getOptions() {
066                                return new DensestSubgraph();
067                        }
068                },
069                CONNECTED_COMPS {
070                        @Override
071                        public ToolMode getOptions() {
072                                return new ConnectedComponents();
073                        }
074                },
075                MDS {
076                        @Override
077                        public ToolMode getOptions() {
078                                return new MDS();
079                        }
080                }
081        }
082        
083        @Option(name="--mode", aliases="-m", required=true, usage="Tool mode", handler=ProxyOptionHandler.class)
084        Mode mode;
085        ToolMode modeOp;
086        
087        @Option(name="--invert", required=false, usage="invert data")
088        boolean invertData = false;
089        
090        @Option(name="--input", aliases="-i", required=true, usage="input similarity matrix")
091        File input;
092        
093        @Option(name="--output", aliases="-o", required=false, usage="Output file. If not given, then output will be printed to stdout")
094        File output = null;
095        
096        public ToolMode getToolMode() {
097                return modeOp;
098        }
099        
100        public SimilarityMatrix getInput() throws IOException {
101                SimilarityMatrix matrix = IOUtils.read(input, SimilarityMatrix.class);
102                
103                if (invertData)
104                        matrix = matrix.processInplace(new InvertData());
105                
106                return matrix;
107        }
108        
109        public File getOutput() {
110                return output;
111        }
112}