eu.project.ttc.resources

Class EvalTrace

java.lang.Object

eu.project.ttc.resources.EvalTrace

All Implemented Interfaces:

org.apache.uima.resource.SharedResourceObject

public class EvalTrace
extends java.lang.Object
implements org.apache.uima.resource.SharedResourceObject

A list of evaluation EvalTrace.RecPoint for precision/recall metrics against against a reference list. This resource is used and filled by EvalEngine. Each EvalTrace.RecPoint holds the number of true positive (tp) extracted terms at a given index (where index is the top n extracted terms) aginst the reference list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EvalTrace.RecPoint

Constructor Summary

Constructors

Constructor and Description
EvalTrace()

Method Summary

Modifier and Type	Method and Description
static void	clear() Remove all evaluation traces.
static EvalTrace	get(java.lang.String traceName)
EvalTrace.RecPoint	getAtRank(int rank) Get the EvalTrace.RecPoint for rank number of extracted indexes.
EvalTrace.RecPoint	getAtRecall(double recallThreshorld) Get the first EvalTrace.RecPoint whose recall exceeds the parameter precisionThreshorld.
java.util.Collection<EvalTrace.RecPoint>	getChartAxisPoints(boolean takeLastPoint)
java.util.Collection<java.lang.Integer>	getIndexes()
EvalTrace.RecPoint	getLast()
double	getMaxRecall()
java.lang.String	getName()
java.util.Collection<EvalTrace.RecPoint>	getPoints()
java.util.Collection<java.lang.Double>	getValues(java.lang.String pName)
void	keepIndexes(java.util.Collection<java.lang.Integer> indexes) Filters this eval trace and keeps only the parameter indexes.
void	load(org.apache.uima.resource.DataResource aData)
void	setRtlSize(int refRtlSize)
EvalTrace	toDisplayable() Creates a clone of this trace with only points that are meant to be displayed on a chart (these points are EvalEngine.CHART_AXIS_POINTS)
java.lang.String	toString()
void	trace(int index, int tp, java.util.List<ReferenceTermList.RTLTerm> foundTerms)

Methods inherited from class java.lang.Object

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

Constructor Detail

EvalTrace

public EvalTrace()

Method Detail

setRtlSize

public void setRtlSize(int refRtlSize)

trace

public void trace(int index,
                  int tp,
                  java.util.List<ReferenceTermList.RTLTerm> foundTerms)

getMaxRecall

public double getMaxRecall()

getLast

public EvalTrace.RecPoint getLast()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAtRecall

public EvalTrace.RecPoint getAtRecall(double recallThreshorld)

Get the first EvalTrace.RecPoint whose recall exceeds the parameter precisionThreshorld.

Parameters:

recallThreshorld -

Returns:

getAtRank

public EvalTrace.RecPoint getAtRank(int rank)

Get the EvalTrace.RecPoint for rank number of extracted indexes.

Parameters:

rank -

Returns:

getIndexes

public java.util.Collection<java.lang.Integer> getIndexes()

getValues

public java.util.Collection<java.lang.Double> getValues(java.lang.String pName)

getPoints

public java.util.Collection<EvalTrace.RecPoint> getPoints()

getChartAxisPoints

public java.util.Collection<EvalTrace.RecPoint> getChartAxisPoints(boolean takeLastPoint)

load

public void load(org.apache.uima.resource.DataResource aData)
          throws org.apache.uima.resource.ResourceInitializationException

Specified by:

load in interface org.apache.uima.resource.SharedResourceObject

Throws:

org.apache.uima.resource.ResourceInitializationException

clear

public static void clear()

Remove all evaluation traces.

get

public static EvalTrace get(java.lang.String traceName)

getName

public java.lang.String getName()

toDisplayable

public EvalTrace toDisplayable()

Creates a clone of this trace with only points that are meant to be displayed on a chart (these points are EvalEngine.CHART_AXIS_POINTS)

Returns:

keepIndexes

public void keepIndexes(java.util.Collection<java.lang.Integer> indexes)

Filters this eval trace and keeps only the parameter indexes.