org.openimaj.ml.annotation.bayes

Enum NaiveBayesAnnotator.Mode

java.lang.Object

java.lang.Enum<NaiveBayesAnnotator.Mode>

org.openimaj.ml.annotation.bayes.NaiveBayesAnnotator.Mode

All Implemented Interfaces:

Serializable, Comparable<NaiveBayesAnnotator.Mode>

Enclosing class:

NaiveBayesAnnotator<OBJECT,ANNOTATION>

public static enum NaiveBayesAnnotator.Mode
extends Enum<NaiveBayesAnnotator.Mode>

Modes of operation for prediction using the NaiveBayesAnnotator.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The probability of each class should be calculated, and the annotations returned should contain every annotation with its associated probability in decreasing order of probability.
MAXIMUM_LIKELIHOOD Only the single most likely annotation will be returned.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract <ANNOTATION> List<ScoredAnnotation<ANNOTATION>>	getAnnotations(gov.sandia.cognition.learning.algorithm.bayes.VectorNaiveBayesCategorizer<ANNOTATION,org.openimaj.ml.annotation.bayes.NaiveBayesAnnotator.PDF> categorizer, gov.sandia.cognition.math.matrix.Vector vec)
static NaiveBayesAnnotator.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static NaiveBayesAnnotator.Mode[]	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

ALL

public static final NaiveBayesAnnotator.Mode ALL

The probability of each class should be calculated, and the annotations returned should contain every annotation with its associated probability in decreasing order of probability.

MAXIMUM_LIKELIHOOD

public static final NaiveBayesAnnotator.Mode MAXIMUM_LIKELIHOOD

Only the single most likely annotation will be returned.

Method Detail

values

public static NaiveBayesAnnotator.Mode[] 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 (NaiveBayesAnnotator.Mode c : NaiveBayesAnnotator.Mode.values())
    System.out.println(c);

Returns:

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

valueOf

public static NaiveBayesAnnotator.Mode 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

getAnnotations

protected abstract <ANNOTATION> List<ScoredAnnotation<ANNOTATION>> getAnnotations(gov.sandia.cognition.learning.algorithm.bayes.VectorNaiveBayesCategorizer<ANNOTATION,org.openimaj.ml.annotation.bayes.NaiveBayesAnnotator.PDF> categorizer,
                                                             gov.sandia.cognition.math.matrix.Vector vec)