com.bbn.bue.common.evaluation

Class BinaryErrorLogger<KeyT extends HasDocID,TestT extends HasDocID>

java.lang.Object

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

All Implemented Interfaces:

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

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

An inspector which logs to a file the binary confusion matrix for an alignment. If an item is aligned, it is counted as PRESENT/PRESENT. If it appears in the key alignment only, it is PRESENT/ABSENT. If it appears in the test alignment onlt, it is ABSENT/PRESENT. This will be written to a file "DOCID/confusionMatrix.txt" in the specified output directory, where DOCID is extracted from the aligned input items. All aligned items must share the same document ID. If the input alignment is empty, no file is written.

Method Summary

Methods

Modifier and Type	Method and Description
void	finish()
static <ItemT extends HasDocID> BinaryErrorLogger<ItemT,ItemT>	forStringifierAndOutputDir(com.google.common.base.Function<? super ItemT,String> stringifier, File outputDirectory) Creates a BinaryErrorLogger.
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

inspect

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

Specified by:

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

finish

public void finish()
            throws IOException

Specified by:

finish in interface Finishable

Throws:

IOException

forStringifierAndOutputDir

public static <ItemT extends HasDocID> BinaryErrorLogger<ItemT,ItemT> forStringifierAndOutputDir(com.google.common.base.Function<? super ItemT,String> stringifier,
                                                                                 File outputDirectory)

Creates a BinaryErrorLogger. The stringifier is a means of rendering the aligned items as strings. If you don't care, choose Functions.toStringFunction().