signalproc.filtering.timedomain

Class FIR_LowPass

java.lang.Object

org.trianacode.taskgraph.Unit

signalproc.filtering.timedomain.FIR_LowPass

public class FIR_LowPass
extends Unit

An FIR_LowPass unit to apply an FIR low-pass filter smoothed by a windowing function chosen by the user. The order (number of points in the filter) and cutoff frequency can also be chosen by the user. The unit maintains continuity across successive input data sets if the user requests it. The computation starts off as if the first data set had been preceded by a sequence of zeros.

Field Summary

Fields inherited from class org.trianacode.taskgraph.Unit

CLONE_ALL_OUTPUT, CLONE_MULTIPLE_OUTPUT, COPY_OUTPUT, ESSENTIAL, ESSENTIAL_IF_CONNECTED, IMMEDIATE_UPDATE, INTERNAL, LATE_INITIALIZE, NO_UPDATE, ON_TASK_INSTANTATION, ON_USER_ACCESS, OPTIONAL, PROCESS_UPDATE, TRANSIENT, TRANSIENT_ACCESSIBLE, USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
FIR_LowPass()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getHelpFile()
java.lang.String[]	getInputTypes() This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g.
java.lang.String[]	getOutputTypes() This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g.
java.lang.String	getPopUpDescription() This returns a brief! description of what the unit does.
void	init() This function is called when the unit is first created.
void	parameterUpdate(java.lang.String name, java.lang.Object value) Used to set each of FIR_LowPass's parameters.
void	process() The main unit algorithm.
void	reset() Reset's FIR_LowPass

Methods inherited from class org.trianacode.taskgraph.Unit

debug, debug, defineParameter, dispose, extractClipInState, getClipIn, getClipIn, getControlInterface, getDefaultInputNodes, getDefaultNodeRequirement, getDefaultOutputNodes, getDisplayName, getDisplayPackage, getGUIBuilderV2Info, getHelpFileLocation, getInputAtNode, getInputNodeCount, getMaximumInputNodes, getMaximumOutputNodes, getMinimumInputNodes, getMinimumOutputNodes, getNodeInputTypes, getNodeOutputTypes, getOutputNodeCount, getOutputPolicy, getPackageName, getParameter, getParameterPanelClass, getParameterPanelInstantiate, getParameterType, getParameterUpdatePolicy, getRunnableInterface, getTask, getTaskGraphContext, getToolName, getToolPackage, getToolTable, getVersion, hideParameterPanel, isClipInName, isInputAtNode, isOutputSent, isParameter, log, log, notifyError, notifyError, output, outputAtNode, outputAtNode, parameterUpdated, putClipIn, removeClipIn, removeParameter, restoreClipInState, setDefaultInputNodes, setDefaultNodeRequirement, setDefaultOutputNodes, setDisplayName, setDisplayPackage, setGUIBuilderV2Info, setHelpFileLocation, setMaximumInputNodes, setMaximumOutputNodes, setMinimumInputNodes, setMinimumOutputNodes, setOutputPolicy, setParameter, setParameterPanelClass, setParameterPanelInstantiate, setParameterUpdatePolicy, setPopUpDescription, setRunnableInterface, setToolName, setToolPackage, setVersion, showParameterPanel, stopping

Methods inherited from class java.lang.Object

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

Constructor Detail

FIR_LowPass

public FIR_LowPass()

Method Detail

process

public void process()
             throws java.lang.Exception

Description copied from class: Unit

The main unit algorithm. This method should be implemented with the appropriate algorihtm for the unit (if no algorithm is implemented deadlock occurs).

Specified by:

process in class Unit

Throws:

java.lang.Exception

init

public void init()

Description copied from class: Unit

This function is called when the unit is first created. It should be over-ridden to initialise the tool properties (e.g. default number of nodes) and tool parameters.

Overrides:

init in class Unit

reset

public void reset()

Reset's FIR_LowPass

Overrides:

reset in class Unit

parameterUpdate

public void parameterUpdate(java.lang.String name,
                   java.lang.Object value)

Used to set each of FIR_LowPass's parameters.

Overrides:

parameterUpdate in class Unit

getInputTypes

public java.lang.String[] getInputTypes()

Description copied from class: Unit

This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getInputTypes in class Unit

Returns:

a string containing the names of the types allowed to be input to FIR_LowPass, each separated by a white space.

getOutputTypes

public java.lang.String[] getOutputTypes()

Description copied from class: Unit

This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getOutputTypes in class Unit

Returns:

an array of the output types for this unit

getPopUpDescription

public java.lang.String getPopUpDescription()

This returns a brief! description of what the unit does. The text here is shown in a pop up window when the user puts the mouse over the unit icon for more than a second.

Overrides:

getPopUpDescription in class Unit

getHelpFile

public java.lang.String getHelpFile()