viper.comparison
Interface Evaluation

All Known Implementing Classes:

FramewiseEvaluation, ObjectEvaluation, TrackingEvaluation

public interface Evaluation

An evaluation is a a high-level method of comparing two sets of descriptors. These include: object matching evaluation, frame-by-frame evaluation at the pixel level, and keyed-object tracking evaluation. Each evaluation technique has its benefits.

Nested Class Summary

static interface

Evaluation.Information Evaluation.Information class for describing evaluation results

Method Summary

java.util.Map	getMeasureMap() Return a map of DescPrototypes to their evaluations.
java.lang.String	getName() Gets the name of the evalutation type.
java.io.PrintWriter	getOutput() Gets the human readable output stream.
int	getTickerSize() Get an estimate on how long it will take to perform the evaluation.
boolean	isPrintingHeaders() Tests to see if the header and footer should be printed out.
void	parseEvaluation(VReader reader, DescriptorConfigs dcfgs) Parse the vreader section.
Evaluation.Information	printEvaluation() Print out the results of this evaluation.
void	printFooter(Evaluation.Information total) Prints the footer information, including overall scores.
void	printHeader() Prints the header information, usually about what metrics and rules were used in the evaluation.
void	printMetricsTo(java.io.PrintWriter out) Print out information about evaluation
void	printRawMetricsTo(java.io.PrintWriter out) Print evaluation info in terse format
void	setMatrix(CompMatrix cm) Sets the matrix to evaluate.
void	setOutput(java.io.PrintWriter output) Sets where human-readable information should be printed.
void	setPrintingHeaders(boolean on) Set to print headers or not.
void	setRaw(java.io.PrintWriter raw) Sets the machine readable raw output stream.
void	setTicker(Revealer ticker) Sets the ui for progress

Method Detail

parseEvaluation

public void parseEvaluation(VReader reader,
                            DescriptorConfigs dcfgs)
                     throws java.io.IOException

Parse the vreader section.

Parameters:

reader - VReader, already pointing at the begin evaluation directive.

dcfgs - the target data - the evaluation uses the target names

Throws:

java.io.IOException

getMeasureMap

public java.util.Map getMeasureMap()

Return a map of DescPrototypes to their evaluations.

Returns:

a map of DescPrototypes to their evaluations

printMetricsTo

public void printMetricsTo(java.io.PrintWriter out)

Print out information about evaluation

Parameters:

out - the output stream

printRawMetricsTo

public void printRawMetricsTo(java.io.PrintWriter out)

Print evaluation info in terse format

Parameters:

out - the raw stream

getName

public java.lang.String getName()

Gets the name of the evalutation type.

Returns:

the name of the evaluation

getTickerSize

public int getTickerSize()

Get an estimate on how long it will take to perform the evaluation. printEvaluation should call revealer.tick() exactly this many times.

Returns:

the length of the ticker

printEvaluation

public Evaluation.Information printEvaluation()

Print out the results of this evaluation. Since the evaluation operates on a CompMatrix level, the Evaluation.Information being passed back allows totals to be printed out at the end.

Returns:

the evaluation information

printHeader

public void printHeader()

Prints the header information, usually about what metrics and rules were used in the evaluation.

printFooter

public void printFooter(Evaluation.Information total)

Prints the footer information, including overall scores.

Parameters:

total - the total

setOutput

public void setOutput(java.io.PrintWriter output)

Sets where human-readable information should be printed.

Parameters:

output - the human readable output stream

getOutput

public java.io.PrintWriter getOutput()

Gets the human readable output stream.

Returns:

the human readable output stream

setRaw

public void setRaw(java.io.PrintWriter raw)

Sets the machine readable raw output stream.

Parameters:

raw - the machine readable stream

setPrintingHeaders

public void setPrintingHeaders(boolean on)

Set to print headers or not.

Parameters:

on - true to print headers

isPrintingHeaders

public boolean isPrintingHeaders()

Tests to see if the header and footer should be printed out.

Returns:

if the header and footer should be printed

setTicker

public void setTicker(Revealer ticker)

Sets the ui for progress

Parameters:

ticker - the progress ui

setMatrix

public void setMatrix(CompMatrix cm)

Sets the matrix to evaluate.

Parameters:

cm - the matrix to evaluate