magpie.optimization.rankers

Class ClassProbabilityRanker

java.lang.Object

magpie.optimization.rankers.BaseEntryRanker

magpie.optimization.rankers.ClassProbabilityRanker

All Implemented Interfaces:

java.lang.Cloneable, Options

public class ClassProbabilityRanker
extends BaseEntryRanker

Rank entries based on the probability that they are a certain class.

Usage: <target class>
target class: Name of class being assessed.

Constructor Summary

Constructors

Constructor and Description
ClassProbabilityRanker()
ClassProbabilityRanker(java.lang.String TargetClass) Create new instance of ranker.

Method Summary

Modifier and Type	Method and Description
double	objectiveFunction(BaseEntry Entry) Some kind of objective function that returns a double when given an entry.
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setTargetClass(java.lang.String TargetClass) Set the name of the class of interest
void	train(Dataset data) Train ranker.

Methods inherited from class magpie.optimization.rankers.BaseEntryRanker

clone, isMaximizing, isUsingMeasured, rankEntries, rankEntries, rankEntries, runObjectiveFunction, setMaximizeFunction, setUseMeasured, sortByRanking

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassProbabilityRanker

public ClassProbabilityRanker()

ClassProbabilityRanker

public ClassProbabilityRanker(java.lang.String TargetClass)

Create new instance of ranker.

Parameters:

TargetClass - Name of target class

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

setTargetClass

public void setTargetClass(java.lang.String TargetClass)

Set the name of the class of interest

Parameters:

TargetClass - Name of target class

objectiveFunction

public double objectiveFunction(BaseEntry Entry)

Description copied from class: BaseEntryRanker

Some kind of objective function that returns a double when given an entry.

NOTE: This function needs to support using either the measured or predicted class depending on the settings

Specified by:

objectiveFunction in class BaseEntryRanker

Parameters:

Entry - Entry to be analyzed

Returns:

Evaluation of target function

train

public void train(Dataset data)

Description copied from class: BaseEntryRanker

Train ranker.

Specified by:

train in class BaseEntryRanker

Parameters:

data - Data to use as training set