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 * Counts some overall statistics of cluster evaluation such as min, max and average cluster length
039 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
040 */
041public class ClusterStatsAnalysis implements AnalysisResult{
042        static class ClusterStats{
043                int max;
044                int min;
045                int nc;
046                double mean;
047                int total;
048                
049                @Override
050                public String toString() {
051                        return String.format("nc=%d,t=%d,mi=%d,ma=%d,me=%2.2f",nc,total,min,max,mean);
052                }
053        }
054        
055        /**
056         * Stats regarding the correct or baseline clusters
057         */
058        public ClusterStats correct;
059        /**
060         * Stats regarding the estimated clusters
061         */
062        public ClusterStats estimated; 
063        @Override
064        public JasperPrint getSummaryReport(String title, String info) throws JRException {
065                throw new UnsupportedOperationException();
066        }
067
068        @Override
069        public JasperPrint getDetailReport(String title, String info) throws JRException {
070                throw new UnsupportedOperationException();
071        }
072
073        @Override
074        public String getSummaryReport() {
075                return String.format("correct={%s},estimated={%s}",correct,estimated);
076        }
077
078        @Override
079        public String getDetailReport() {
080                return this.getSummaryReport();
081        }
082        
083        @Override
084        public String toString() {
085                return getSummaryReport();
086        }
087}