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 * Sina Samangooei (ss@ecs.soton.ac.uk)
039 *
040 */
041public class FullMEAnalysis implements AnalysisResult{
042
043        /**
044         * A measure of how pure each cluster is.
045         * P = 1/N Sigma_k max_j | w_k AND c_j |
046         *
047         * Count the true classes of all the elements in a class, make a count of the largest group from each cluster,
048         * divide by number of elements in all clusters.
049         *
050         * High means: most of the clusters had a high number of a single class
051         * Low means: most of the clusters had a roughly equal spread of all the classes
052         */
053        public PurityAnalysis purity;
054        
055        /**
056         * the {@link NMIAnalysis} instance
057         */
058        public NMIAnalysis nmi;
059
060        /**
061         * The {@link DecisionAnalysis} instance
062         */
063        public DecisionAnalysis decision;
064        
065        /**
066         * The {@link FScoreAnalysis} instance
067         */
068        public FScoreAnalysis fscore;
069        
070        /**
071         * The {@link RandomIndexAnalysis} instance
072         */
073        public RandomIndexAnalysis randIndex;
074        
075        /**
076         * 
077         */
078        public AnalysisResult adjRandInd;
079
080
081        @Override
082        public String getSummaryReport() {
083                return String.format("(%s,%s,%s,%s,%s,%s)",purity,nmi,decision,fscore,randIndex,adjRandInd);
084        }
085
086        @Override
087        public String getDetailReport() {
088                return "";
089        }
090
091
092        @Override
093        public JasperPrint getSummaryReport(String title, String info) throws JRException {throw new UnsupportedOperationException();}
094
095        @Override
096        public JasperPrint getDetailReport(String title, String info)throws JRException {throw new UnsupportedOperationException();}
097
098}