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 RandomIndexAnalysis implements AnalysisResult, RandomBaselineWrappable{
042        private DecisionAnalysis ann;
043
044        /**
045         * @param ann
046         */
047        public RandomIndexAnalysis(DecisionAnalysis ann) {
048                this.ann = ann;
049        }
050        
051        /**
052         * @return the underlying decision analysis
053         */
054        public DecisionAnalysis getDecisionAnalysis(){
055                return this.ann;
056        }
057        
058        @Override
059        public String toString() {
060                return this.getSummaryReport();
061        }
062        
063        @Override
064        public String getSummaryReport() {
065                return String.format("randIndex=%2.5f",randIndex());
066        }
067
068        @Override
069        public String getDetailReport() {
070                return this.getSummaryReport();
071        }
072        
073        @Override
074        public JasperPrint getSummaryReport(String title, String info) throws JRException {
075                throw new UnsupportedOperationException();
076        }
077
078        @Override
079        public JasperPrint getDetailReport(String title, String info)throws JRException {
080                throw new UnsupportedOperationException();
081        }
082        @Override
083        public double score() {
084                return randIndex();
085        }
086        
087        /**
088         * @return the proportion of true decisions made as compared to all decisions made
089         */
090        public double randIndex() {
091                return (ann.TP + ann.TN) / (double)(ann.TP + ann.FP + ann.TN + ann.FN);
092        }
093
094}