org.imirsel.m2k.evaluation
Class ClassificationResultRead

java.lang.Object
  java.util.Observable
      ncsa.d2k.core.modules.RootModule
          ncsa.d2k.core.modules.ConfigurableModule
              ncsa.d2k.core.modules.EmbeddedPipeModule
                  ncsa.d2k.core.modules.ExecModule
                      ncsa.d2k.core.modules.IOModule
                          ncsa.d2k.core.modules.InputModule
                              org.imirsel.m2k.evaluation.ClassificationResultRead

All Implemented Interfaces:

java.lang.Cloneable, ncsa.d2k.core.modules.Module, java.io.Serializable, ncsa.d2k.core.modules.SystemModule

public class ClassificationResultRead

extends ncsa.d2k.core.modules.InputModule

Reads in GroundTruth file and Algorithm Output file into a Signal object

Author:

Xiao

See Also:

Serialized Form

Field Summary

Fields inherited from class ncsa.d2k.core.modules.ConfigurableModule

addedInputInfo, addedInputNames, addedInputTypes, addedOutputInfo, addedOutputNames, addedOutputTypes, addPortListeners

Fields inherited from class ncsa.d2k.core.modules.RootModule

alias, children, DEBUG_LEVEL, EMPTY_INPUT, ERROR_LEVEL, executionManager, FATAL_LEVEL, HAVE_INPUT, INFO_LEVEL, iPipes, iPipesIndex, iTriggers, oPipes, oPipesIndex, oTriggers, parents, pipesFullManager, stats, triggerChildren, triggerParents, WARN_LEVEL

Fields inherited from interface ncsa.d2k.core.modules.SystemModule

BLOCKED_STATE, IDLE_STATE, MEDIUM, MEDIUM_RARE, MEDIUM_WELL, RARE, READY_STATE, WELL, WORKING_STATE

Constructor Summary

ClassificationResultRead()
Create a new instance of ResultRead

Method Summary

void	doit() Reads in two File Objects, extracts metadata and inputs them into Signal objects.
java.lang.String	getInputInfo(int param) Returns a text description for the indicated input
java.lang.String	getInputName(int i) Returns a text name for the indicated output
java.lang.String[]	getInputTypes() Returns an array of strings containing the Java data types of the input.
java.lang.String	getModuleInfo() Returns information about the module
int	getNumExamples() Gets number of examples
java.lang.String	getOutputInfo(int param) Returns a text description for the indicated output
java.lang.String	getOutputName(int i) Returns a text name for the indicated output
java.lang.String[]	getOutputTypes() Returns an array of strings containing the Java data types of the outputs.
ncsa.d2k.core.modules.PropertyDescription[]	getPropertiesDescriptions() Returns an array of description objects for each property of the Module.
boolean	getVerbose() Gets the flag of verbose
void	setNumExamples(int value) Sets number of examples
void	setVerbose(boolean value) Sets the flag of verbose output to console

Methods inherited from class ncsa.d2k.core.modules.ExecModule

execute, setExecutionManager

Methods inherited from class ncsa.d2k.core.modules.ConfigurableModule

addAddPortListener, addInput, addInputTrigger, addOutput, addOutputTrigger, getAddedInputTypes, getAddedOutputTypes, getAddPortListeners, insertInput, insertOutput, removeAddPortListener, removeInput, removeInputTrigger, removeOutput, removeOutputTrigger, setAddedInputTypes, setInputType, setOutputType

Methods inherited from class ncsa.d2k.core.modules.RootModule

activateTriggers, begin, beginExecution, canRun, clone, debug, debug, disconnectInputPipe, disconnectInputTriggers, disconnectOutputPipe, disconnectOutputTriggers, end, endExecution, error, error, fatal, fatal, fetchInputs, getAlias, getChildIndex, getChildMux, getChildren, getExecutionManager, getFile, getFlags, getFullPipeManager, getGuiComponent, getImage, getInputPipes, getInputPipeSize, getInputTriggers, getModuleName, getModuleStatistics, getNumInputs, getNumOutputs, getOutputCounts, getOutputPipes, getOutputPipeSize, getOutputTriggers, getParentIndex, getParentMux, getParents, getPipesFull, getPriority, getPropertyEditor, getResource, getRootName, getState, info, info, initModule, isAborting, isHead, isInputPipeConnected, isOutputPipeConnected, isReady, pullInput, pushOutput, resetInputs, setAlias, setBlocked, setD2KModulesLoggingLevel, setFlags, setFullPipeManager, setIdle, setInputPipe, setLogLevel, setModuleStatistics, setModuleStatisticsByMachine, setOutputCounts, setOutputPipe, setPipesFull, setReady, setResource, setState, setThePriority, setWorking, trigger, triggersActivated, warn, warn

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassificationResultRead

public ClassificationResultRead()

Create a new instance of ResultRead

Method Detail

setVerbose

public void setVerbose(boolean value)

Sets the flag of verbose output to console

Parameters:

value - verbose flag

getVerbose

public boolean getVerbose()

Gets the flag of verbose

Returns:

flag of verbose

setNumExamples

public void setNumExamples(int value)

Sets number of examples

Parameters:

value - number of examples

getNumExamples

public int getNumExamples()

Gets number of examples

Returns:

number of examples

getPropertiesDescriptions

public ncsa.d2k.core.modules.PropertyDescription[] getPropertiesDescriptions()

Returns an array of description objects for each property of the Module.

Returns:

an array of description objects for each property of the Module.

getModuleInfo

public java.lang.String getModuleInfo()

Returns information about the module

Returns:

Module information

getInputInfo

public java.lang.String getInputInfo(int param)

Returns a text description for the indicated input

Parameters:

param - the index of the input

Returns:

a text description of the indexed input

getInputTypes

public java.lang.String[] getInputTypes()

Returns an array of strings containing the Java data types of the input.

Returns:

the fully qualified java types for each of the inputs

getInputName

public java.lang.String getInputName(int i)

Returns a text name for the indicated output

Parameters:

i - the index of the output

Returns:

the name of the indexed output

getOutputInfo

public java.lang.String getOutputInfo(int param)

Returns a text description for the indicated output

Parameters:

param - the index of the output

Returns:

the text description for the indicated output

getOutputTypes

public java.lang.String[] getOutputTypes()

Returns an array of strings containing the Java data types of the outputs.

Returns:

the fully qualified java types for each of the outputs.

getOutputName

public java.lang.String getOutputName(int i)

Returns a text name for the indicated output

Parameters:

i - the index of the output

Returns:

the name of the indexed output

doit

public void doit()

Reads in two File Objects, extracts metadata and inputs them into Signal objects. First check if the length of classification result File object equals or is larger than that of ground truth File object. If not, print out an error message. Second check if the classification result File actually contains all entries in the ground truth File.