viper.comparison
Class TrackingInformation

java.lang.Object
  viper.comparison.TrackingInformation

All Implemented Interfaces:

Evaluation.Information

public class TrackingInformation

extends java.lang.Object

implements Evaluation.Information

Collects scores for the tracking evaluatoin type

Constructor Summary

TrackingInformation(java.lang.Object ID)
Create a new tracking information object with the given default id.

Method Summary

void	add(Evaluation.Information other) Sums another information to this one, usually from two different CompMatrices.
void	addMetric(java.lang.String attrName, Distance metric) Adds a new metric to the collection.
java.util.Map	getDatasets(java.lang.String name) Get a map of chart titles (actually, distance objects) to Datasets.
java.lang.String	getLayout() Gets the layout for the toString format.
java.util.List	getOrder() Gets the order of output.
double	getValue(java.lang.String attrName, Distance metric) Gets the current value of the metric on the specified attribute type.
boolean	hasInformation() Indicates if anything was found.
void	setOrder(java.util.List order) Sets the order of output.
void	setValue(java.lang.String attrName, Distance metric, double value) Sets the value of this information
void	setValue(java.lang.String attrName, Distance metric, java.lang.Number value) Sets the value of this information
java.lang.String	toString() Get output suitable for .raw files.
java.lang.String	toVerbose() Get output suitable for .out files; may include new lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackingInformation

public TrackingInformation(java.lang.Object ID)

Create a new tracking information object with the given default id.

Parameters:

ID - the descriptor id to associate with the tracking information

Method Detail

hasInformation

public boolean hasInformation()

Description copied from interface: Evaluation.Information

Indicates if anything was found. Useful for avoiding 0/0 errors.

Specified by:

hasInformation in interface Evaluation.Information

Returns:

if the comparison graph was non-empty

toVerbose

public java.lang.String toVerbose()

Description copied from interface: Evaluation.Information

Get output suitable for .out files; may include new lines.

Specified by:

toVerbose in interface Evaluation.Information

Returns:

output suitable for .out files

toString

public java.lang.String toString()

Description copied from interface: Evaluation.Information

Get output suitable for .raw files. Must follow format given by getLayout().

Specified by:

toString in interface Evaluation.Information

getLayout

public java.lang.String getLayout()

Description copied from interface: Evaluation.Information

Gets the layout for the toString format.

Specified by:

getLayout in interface Evaluation.Information

Returns:

the layout string

add

public void add(Evaluation.Information other)

Description copied from interface: Evaluation.Information

Sums another information to this one, usually from two different CompMatrices.

Specified by:

add in interface Evaluation.Information

Parameters:

other - the information to add to this

setOrder

public void setOrder(java.util.List order)

Sets the order of output.

Parameters:

order - a list of Distance functors

getOrder

public java.util.List getOrder()

Gets the order of output.

Returns:

a list of Distance functors

setValue

public void setValue(java.lang.String attrName,
                     Distance metric,
                     double value)

Sets the value of this information

Parameters:

attrName - the attribute name

metric - the metric used for tracking

value - the value of the track on the given attribute

setValue

public void setValue(java.lang.String attrName,
                     Distance metric,
                     java.lang.Number value)

Sets the value of this information

Parameters:

attrName - the attribute name

metric - the metric used for tracking

value - the value of the track on the given attribute

addMetric

public void addMetric(java.lang.String attrName,
                      Distance metric)

Adds a new metric to the collection.

Parameters:

attrName - the attribute for the metric

metric - the distance metric

getValue

public double getValue(java.lang.String attrName,
                       Distance metric)

Gets the current value of the metric on the specified attribute type.

Parameters:

attrName - the attribute

metric - the metric

Returns:

the current aggregate value

getDatasets

public java.util.Map getDatasets(java.lang.String name)

Description copied from interface: Evaluation.Information

Get a map of chart titles (actually, distance objects) to Datasets.

Specified by:

getDatasets in interface Evaluation.Information

Parameters:

name - Associate the series in each dataset with this name.

Returns:

the chart titles to data sets