org.imirsel.m2k.util
Class CreateTestandTrainSignalArrays

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.DataPrepModule
                              org.imirsel.m2k.util.CreateTestandTrainSignalArrays

All Implemented Interfaces:

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

public class CreateTestandTrainSignalArrays

extends ncsa.d2k.core.modules.DataPrepModule

A module that collects input Signal arrays until a null input is received, splits them into a test and training set and outputs them. Each array is split evenly across the test and training sets. The proportion of data to be used for training is controlled by the TrainingProportion parameter.

Author:

kw

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

CreateTestandTrainSignalArrays()
Creates a new instance of CreateTestandTrainMatrices

Method Summary

void	beginExecution() Clears variable before the module is run
protected void	doit() Collects input Signal arrays until a null input is received, splits them into a test and training set and outputs them.
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
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
double	getTrainingProportion() Returns the proportion of data to be used for training
boolean	isReady() A method that allows the module to run based on the input flags
void	setTrainingProportion(double val) Sets the proportion of data to be used for training

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

CreateTestandTrainSignalArrays

public CreateTestandTrainSignalArrays()

Creates a new instance of CreateTestandTrainMatrices

Method Detail

getTrainingProportion

public double getTrainingProportion()

Returns the proportion of data to be used for training

Returns:

the proportion of data to be used for training

setTrainingProportion

public void setTrainingProportion(double val)

Sets the proportion of data to be used for training

Parameters:

val - the proportion of data to be used for training

getModuleInfo

public java.lang.String getModuleInfo()

Returns information about the module

Returns:

Module information

beginExecution

public void beginExecution()

Clears variable before the module is run

getPropertiesDescriptions

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

Returns a description of each property

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

Returns:

a flag indicating whether the module is ready to run.

doit

protected void doit()
             throws java.lang.Exception

Collects input Signal arrays until a null input is received, splits them into a test and training set and outputs them. Each array is split evenly across the test and training sets. The proportion of data to be used for training is controlled by the TrainingProportion parameter.

Throws:

java.lang.Exception - If an error occurs

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