org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix

Enum CMAnalyser.Strategy

java.lang.Object

java.lang.Enum<CMAnalyser.Strategy>

org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser.Strategy

All Implemented Interfaces:

Serializable, Comparable<CMAnalyser.Strategy>

Enclosing class:

CMAnalyser<OBJECT,CLASS>

public static enum CMAnalyser.Strategy
extends Enum<CMAnalyser.Strategy>

Strategies for building confusion matrices

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
MULTIPLE Strategy for multiple possible actual classes and predicted classes.
MULTIPLE_ORDERED Strategy for multiple possible actual classes and predicted classes in the case the predictions and actual classes are ordered and there is a one-to-one correspondence.
SINGLE Strategy to use when there is exactly one actual class and one predicted class.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract <CLASS> void	add(List<gov.sandia.cognition.learning.data.TargetEstimatePair<CLASS,CLASS>> data, Set<CLASS> predicted, Set<CLASS> actual)
static CMAnalyser.Strategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static CMAnalyser.Strategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SINGLE

public static final CMAnalyser.Strategy SINGLE

Strategy to use when there is exactly one actual class and one predicted class.

MULTIPLE

public static final CMAnalyser.Strategy MULTIPLE

Strategy for multiple possible actual classes and predicted classes. Deals with:

1. true positives (a class present in both the predicted and actual set
2. false positives (a predicted class not being in the actual set)
3. false negatives (an actual class not being in the predicted set)

False positives and negatives are dealt with by using null values for the actual/predicted class respectively.

MULTIPLE_ORDERED

public static final CMAnalyser.Strategy MULTIPLE_ORDERED

Strategy for multiple possible actual classes and predicted classes in the case the predictions and actual classes are ordered and there is a one-to-one correspondence.

A RuntimeException will be thrown if the sets are not the same size and both instances of LinkedHashSet.

Method Detail

values

public static CMAnalyser.Strategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CMAnalyser.Strategy c : CMAnalyser.Strategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CMAnalyser.Strategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

add

protected abstract <CLASS> void add(List<gov.sandia.cognition.learning.data.TargetEstimatePair<CLASS,CLASS>> data,
               Set<CLASS> predicted,
               Set<CLASS> actual)