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
032/**
033 * A set of measures used to evaluate clustering. These metrics are taken from
034 * the <a href=
035 * "http://nlp.stanford.edu/IR-book/html/htmledition/evaluation-of-clustering-1.html"
036 * >Introduction to Information Retrieval</a>.
037 * 
038 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
039 * 
040 */
041public class SimpleMEClusterAnalyser implements ClusterAnalyser<SimpleMEAnalysis> {
042        @Override
043        public SimpleMEAnalysis analyse(int[][] correct, int[][] estimated) {
044                final SimpleMEAnalysis ret = new SimpleMEAnalysis();
045                ret.purity = new PurityClusterAnalyser().analyse(correct, estimated);
046                ret.randIndex = new RandomIndexClusterAnalyser().analyse(correct, estimated);
047                ret.decision = ret.randIndex.getDecisionAnalysis();
048                ret.fscore = new FScoreAnalysis(ret.randIndex.getDecisionAnalysis());
049                ret.adjRandInd = new AdjustedRandomIndexClusterAnalyser().analyse(correct, estimated);
050                return ret;
051        }
052}