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.experiment.evaluation.cluster.analyser;
031
032import net.sf.jasperreports.engine.JRException;
033import net.sf.jasperreports.engine.JasperPrint;
034
035import org.openimaj.experiment.evaluation.AnalysisResult;
036
037/**
038 * Counting the number of true positives, true negatives, flase postitives and false negatives
039 * one can produce various cluster quality metrics including the fscore and randindex
040 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
041 */
042public class DecisionAnalysis implements AnalysisResult{
043
044        /**
045         * The total number of pairs in a cluster which belong to the same class
046         */
047        public long TP;
048        /**
049         * The total number of pairs in a cluster which do not belong to the same class
050         */
051        public long FP;
052        /**
053         * The total number of pairs in different clusters which belong to different classes
054         */
055        public long TN;
056        /**
057         * The total number of pairs in different clusters which belong to the same class
058         */
059        public long FN;
060
061        @Override
062        public JasperPrint getSummaryReport(String title, String info) throws JRException {
063                throw new UnsupportedOperationException();
064        }
065
066        @Override
067        public JasperPrint getDetailReport(String title, String info) throws JRException {
068                throw new UnsupportedOperationException();
069        }
070
071        @Override
072        public String getSummaryReport() {
073                return toString();
074        }
075
076        @Override
077        public String getDetailReport() {
078                return toString();
079        }
080        
081        @Override
082        public String toString() {
083                return String.format("{tp=%d,fp=%d,tn=%d,fn=%d,P=%2.2f,R=%2.5f}",TP,FP,TN,FN,precision(),recall());
084        }
085        
086        /**
087         * @return The number of true positives as a proportion of overall positives 
088         */
089        public double precision(){
090                if( TP + FP == 0) return 0;
091                return TP / (double)(TP + FP);
092        };
093
094        /**
095         * @return The number of true positives as a porportion of true positives and false negatives
096         */
097        public double recall(){
098                if( TP + FN == 0) return 0;
099                return TP / (double)(TP + FN);
100        };
101
102}