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.classification;
031
032import java.util.Map;
033import java.util.Set;
034
035import org.openimaj.experiment.evaluation.AnalysisResult;
036
037/**
038 * A {@link ClassificationAnalyser} is used to analyse the raw 
039 * results from a {@link Classifier} in the context of
040 * a {@link ClassificationEvaluator} and to produce an {@link AnalysisResult}
041 * describing the performance of the {@link ClassificationEvaluator}.
042 * 
043 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
044 *
045 * @param <RESULT> The type of {@link AnalysisResult} produced
046 * @param <CLASS> The type of classes produced by the {@link Classifier}
047 * @param <OBJECT> The type of object classifed by the {@link Classifier}
048 */
049public interface ClassificationAnalyser<RESULT extends AnalysisResult, CLASS, OBJECT> {
050        /**
051         * Analyse the performance of the predicted results against the actual
052         * ground-truth results.
053         * 
054         * @param predicted the predictions from the classifier
055         * @param actual the ground-truth
056         * @return an object representing the analysed results
057         */
058        public RESULT analyse(Map<OBJECT, ClassificationResult<CLASS>> predicted, Map<OBJECT, Set<CLASS>> actual);
059}