org.openimaj.experiment.evaluation.classification

Interface ClassificationResult<CLASS>

Type Parameters:

CLASS - type of classes predicted

All Known Implementing Classes:

BasicClassificationResult

public interface ClassificationResult<CLASS>

The result of a Classifier. The ClassificationResult models one or more assigned classes together with associated confidence values for each class.

Normally, confidence values are bounded between 0 and 1.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
double	getConfidence(CLASS clazz) Get the confidence associated with the given class.
Set<CLASS>	getPredictedClasses() Get the set of classes predicted by this result.

Method Detail

getConfidence

double getConfidence(CLASS clazz)

Get the confidence associated with the given class. If the class is unknown, then this method should return 0.

Normally, confidence values are bounded between 0 and 1.

Parameters:

clazz - the target class.

Returns:

the confidence in assigning the class.

getPredictedClasses

Set<CLASS> getPredictedClasses()

Get the set of classes predicted by this result. Usually, this is a subset of all classes; specifically those with a high confidence.

Returns:

the set of predicted classes.