de.lmu.ifi.dbs.elki.evaluation.classification

Class ConfusionMatrixEvaluationResult

java.lang.Object

de.lmu.ifi.dbs.elki.evaluation.classification.ConfusionMatrixEvaluationResult

All Implemented Interfaces:

Result, TextWriteable

public class ConfusionMatrixEvaluationResult
extends Object
implements Result, TextWriteable

Provides the prediction performance measures for a classifier based on the confusion matrix. Note: this API is non-final, and will be refactored soon.

Since:

0.7.0

Author:

Arthur Zimek

Field Summary

Fields

Modifier and Type	Field and Description
private ConfusionMatrix	confusionmatrix Holds the confusion matrix.
private String	evaluationName Holds the used EvaluationProcedure.

Constructor Summary

Constructors

Constructor and Description
ConfusionMatrixEvaluationResult(ConfusionMatrix confusionmatrix, String evaluationName) Provides an evaluation based on the given confusion matrix.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
String	getShortName() A short name for the result, useful for file names.
void	writeToText(TextWriterStream out, String label) Write self to the given TextWriterStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

confusionmatrix

private ConfusionMatrix confusionmatrix

Holds the confusion matrix.

evaluationName

private String evaluationName

Holds the used EvaluationProcedure.

Constructor Detail

ConfusionMatrixEvaluationResult

public ConfusionMatrixEvaluationResult(ConfusionMatrix confusionmatrix,
                               String evaluationName)

Provides an evaluation based on the given confusion matrix.

Parameters:

confusionmatrix - the confusion matrix to provide the prediction performance measures for

evaluationName - name of the evaluation procedure used

Method Detail

writeToText

public void writeToText(TextWriterStream out,
               String label)

Description copied from interface: TextWriteable

Write self to the given TextWriterStream

Specified by:

writeToText in interface TextWriteable

Parameters:

out - Output writer

label - Label

getLongName

public String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name