org.imirsel.m2k.evaluation
Class AudioTempoExtractionEvaluator

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.ComputeModule
                          org.imirsel.m2k.evaluation.AudioTempoExtractionEvaluator

All Implemented Interfaces:

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

public class AudioTempoExtractionEvaluator

extends ncsa.d2k.core.modules.ComputeModule

implements java.io.Serializable

Takes an array of Signal objects with key metadata as ground turth and another corresponding array of Signal objects with key metadata to be tested for accuracy. If subsequent arrays of Signal objects are received the results are averaged and the standard deviation of the accuracy scores is reported.

Author:

Kris West modified by Xiao on May 2, 2005 modified by Kris West for key finding

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

AudioTempoExtractionEvaluator()
Creates a new instance of SignalArrayAccuracy

Method Summary

void	beginExecution() Clears variable before the module is run
protected void	doit() Takes an array of Signal objects with key metadata as ground turth and another corresponding array of Signal objects with key metadata to be tested for accuracy.
java.lang.String	getCopyToDirectory() Returns the value of CopyToDirectory
java.lang.String	getInputInfo(int i) Returns a text name for the indicated output
java.lang.String	getInputName(int param) Returns a text description for the indicated input
java.lang.String[]	getInputTypes() Returns an array of strings containing the Java data types of the input.
java.lang.String	getModelName() Returns the ModelName parameter, used to identiry which model the accuracy results apply to
java.lang.String	getModuleInfo() Returns information about the module
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 a description of each property
boolean	getVerbose() Returns the value of the verbose output flag
boolean	isReady() A method that allows the module to run based on the input flags
void	setCopyToDirectory(java.lang.String value) Sets the value of CopyToDirectory
void	setModelName(java.lang.String val) Sets the name parameter, used to identiry which model the accuracy results apply to
void	setVerbose(boolean value) Sets the value of the verbose output flag

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, 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, 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

AudioTempoExtractionEvaluator

public AudioTempoExtractionEvaluator()

Creates a new instance of SignalArrayAccuracy

Method Detail

getModelName

public java.lang.String getModelName()

Returns the ModelName parameter, used to identiry which model the accuracy results apply to

Returns:

the name parameter

setModelName

public void setModelName(java.lang.String val)

Sets the name parameter, used to identiry which model the accuracy results apply to

Parameters:

val - the name parameter

setVerbose

public void setVerbose(boolean value)

Sets the value of the verbose output flag

Parameters:

value - the value which verbose is set to

See Also:

#verbose

getVerbose

public boolean getVerbose()

Returns the value of the verbose output flag

Returns:

verbose

See Also:

#verbose

setCopyToDirectory

public void setCopyToDirectory(java.lang.String value)

Sets the value of CopyToDirectory

Parameters:

value - the value which CopyToDirectory is set to

getCopyToDirectory

public java.lang.String getCopyToDirectory()

Returns the value of CopyToDirectory

Returns:

CopyToDirectory

getPropertiesDescriptions

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

Returns a description of each property

Specified by:

getPropertiesDescriptions in interface ncsa.d2k.core.modules.Module

Returns:

An array containing a description of each property

isReady

public boolean isReady()

A method that allows the module to run based on the input flags

Specified by:

isReady in interface ncsa.d2k.core.modules.Module

Returns:

a boolean flag indicating whether the module is ready to run

beginExecution

public void beginExecution()

Clears variable before the module is run

Specified by:

beginExecution in interface ncsa.d2k.core.modules.Module

doit

protected void doit()
             throws java.lang.Exception

Takes an array of Signal objects with key metadata as ground turth and another corresponding array of Signal objects with key metadata to be tested for accuracy. If subsequent arrays of Signal objects are received the results are averaged and the standard deviation of the accuracy scores is reported.

Throws:

java.lang.Exception - if an error occurs

getInputName

public java.lang.String getInputName(int param)

Returns a text description for the indicated input

Specified by:

getInputName in interface ncsa.d2k.core.modules.Module

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.

Specified by:

getInputTypes in interface ncsa.d2k.core.modules.Module

Returns:

the fully qualified java types for each of the inputs

getInputInfo

public java.lang.String getInputInfo(int i)

Returns a text name for the indicated output

Specified by:

getInputInfo in interface ncsa.d2k.core.modules.Module

Parameters:

i - the index of the output

Returns:

the name of the indexed output

getModuleInfo

public java.lang.String getModuleInfo()

Returns information about the module

Specified by:

getModuleInfo in interface ncsa.d2k.core.modules.Module

Returns:

Module information

getOutputInfo

public java.lang.String getOutputInfo(int param)

Returns a text description for the indicated output

Specified by:

getOutputInfo in interface ncsa.d2k.core.modules.Module

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.

Specified by:

getOutputTypes in interface ncsa.d2k.core.modules.Module

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

Specified by:

getOutputName in interface ncsa.d2k.core.modules.Module

Parameters:

i - the index of the output

Returns:

the name of the indexed output