com.bbn.bue.common.evaluation

Class AggregateBinaryFScoresInspector<KeyT,TestT>

java.lang.Object

com.bbn.bue.common.evaluation.AggregateBinaryFScoresInspector<KeyT,TestT>

All Implemented Interfaces:

Finishable, Inspector<Alignment<? extends KeyT,? extends TestT>>

@Beta
public final class AggregateBinaryFScoresInspector<KeyT,TestT>
extends Object
implements Inspector<Alignment<? extends KeyT,? extends TestT>>

Observes an Alignment between system items on the left and gold standard items on the right. A system/gold item is assumed to be found if aligned. Writes summary F-measure scores and an absent/present confusion matrix based on its observations. Although this only implements Inspector<Alignment<Object,Object>>, it is safe to cast it to inspect any alignment.

Method Summary

Methods

Modifier and Type	Method and Description
static <KeyT,TestT> AggregateBinaryFScoresInspector<KeyT,TestT>	createOutputtingTo(String outputName, File outputDir)
static <KeyT,TestT> AggregateBinaryFScoresInspector<KeyT,TestT>	createWithScoringObservers(String outputName, File outputDir, Iterable<? extends ScoringEventObserver<? super KeyT,? super TestT>> scoringObservers)
void	finish()
void	inspect(Alignment<? extends KeyT,? extends TestT> alignment)

Methods inherited from class java.lang.Object

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

Method Detail

createOutputtingTo

public static <KeyT,TestT> AggregateBinaryFScoresInspector<KeyT,TestT> createOutputtingTo(String outputName,
                                                                          File outputDir)

createWithScoringObservers

public static <KeyT,TestT> AggregateBinaryFScoresInspector<KeyT,TestT> createWithScoringObservers(String outputName,
                                                                                  File outputDir,
                                                                                  Iterable<? extends ScoringEventObserver<? super KeyT,? super TestT>> scoringObservers)

finish

public void finish()
            throws IOException

Specified by:

finish in interface Finishable

Throws:

IOException

inspect

public void inspect(Alignment<? extends KeyT,? extends TestT> alignment)

Specified by:

inspect in interface Inspector<Alignment<? extends KeyT,? extends TestT>>