org.imirsel.m2k.math
Class HalfWaveRectifier

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.math.HalfWaveRectifier

All Implemented Interfaces:

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

public class HalfWaveRectifier

extends ncsa.d2k.core.modules.ComputeModule

Performs half-wave rectification. A D2K/M2K module that takes the input data and applies a threshold such that the output contains no values lower than the threshold.

Author:

$author$

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

HalfWaveRectifier()

Method Summary

protected void	doit() Performs the half wave rectification.
java.lang.String	getInputInfo(int i) Returns a text description for the indicated input.
java.lang.String	getInputName(int i) Returns a text name for the given input.
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	getModuleName() Returns the name of the module.
java.lang.String	getOutputInfo(int i) Returns a text description for the given output.
java.lang.String	getOutputName(int i) Returns a text name for the given 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.
double	getThreshold() Returns the threshold.
void	setThreshold(double threshold) Sets the threshold for the rectified function.

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

HalfWaveRectifier

public HalfWaveRectifier()

Method Detail

getModuleName

public java.lang.String getModuleName()

Returns the name of the module.

Returns:

the module name

getModuleInfo

public java.lang.String getModuleInfo()

Returns information about the module.

Returns:

Module information

setThreshold

public void setThreshold(double threshold)

Sets the threshold for the rectified function.

Parameters:

threshold - the threshold below which the input function is clipped.

See Also:

getThreshold()

getThreshold

public double getThreshold()

Returns the threshold.

Returns:

the threshold

See Also:

setThreshold(double)

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.

getInputName

public java.lang.String getInputName(int i)

Returns a text name for the given input.

Parameters:

i - the index of the input

Returns:

the name of the indexed input

getInputInfo

public java.lang.String getInputInfo(int i)

Returns a text description for the indicated input.

Parameters:

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

getOutputName

public java.lang.String getOutputName(int i)

Returns a text name for the given output.

Parameters:

i - the index of the output

Returns:

the name of the indexed output

getOutputInfo

public java.lang.String getOutputInfo(int i)

Returns a text description for the given output.

Parameters:

i - the index of the output

Returns:

the name of the indexed 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.

doit

protected void doit()

Performs the half wave rectification. Generates an output array that is identical to the input array except that all values below the threshold are set to the threshold. The input array is not modified.