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 * Uses a decision analysis to produce the random index result
039 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
040 */
041public class FScoreAnalysis implements AnalysisResult, RandomBaselineWrappable{
042        private DecisionAnalysis ann;
043
044        /**
045         * @param ann
046         */
047        public FScoreAnalysis(DecisionAnalysis ann) {
048                this.ann = ann;
049        }
050        @Override
051        public String getSummaryReport() {
052                return String.format("f1=%2.5f",fscore(1));
053        }
054
055        @Override
056        public String getDetailReport() {
057                return this.getSummaryReport();
058        }
059        
060        @Override
061        public JasperPrint getSummaryReport(String title, String info) throws JRException {
062                throw new UnsupportedOperationException();
063        }
064
065        @Override
066        public JasperPrint getDetailReport(String title, String info)throws JRException {
067                throw new UnsupportedOperationException();
068        }
069        @Override
070        public double score() {
071                return fscore(1);
072        }
073        
074        /**
075         * @return the proportion of true decisions made as compared to all decisions made
076         */
077        public double randIndex() {
078                return (ann.TP + ann.TN) / (double)(ann.TP + ann.FP + ann.TN + ann.FN);
079        }
080        
081        @Override
082        public String toString() {
083                return this.getSummaryReport();
084        }
085        /**
086         * @param beta
087         * @return the f-score which weights up or down the relative importance of a false positive against false negatives
088         */
089        public double fscore(double beta){
090                double beta2 = beta * beta;
091                double P = ann.precision();
092                double R = ann.recall();
093                if(P + R == 0) return 0;
094                return ((beta2 + 1) * P * R)/(beta2 * P + R);
095        }
096        
097        /**
098         * @return the underlying decision analysis
099         */
100        public DecisionAnalysis getDecisionAnalysis(){
101                return this.ann;
102        }
103
104}