signalproc.algorithms

Class FreqHist

java.lang.Object

org.trianacode.taskgraph.Unit

signalproc.algorithms.FreqHist

public class FreqHist
extends Unit

A FreqHist unit to produce a Histogram from an input VectorType. The Histogram records the number of input data elements that lie between a series of values. The unit takes values of the number of histogram bins, the width of each bin, and the starting value for the lowest bin from the parameter window. If any of these are set to "auto" then defaults are calculated from the properties of the input data. The number of histogram values is always larger than the number specified by the user, since an over-spill bin extending to postiive infinity and (if there are any negative data values) another over-spill bin extending to negative infinity are added to catch outliers. Even if a given data set has no such outliers, the extra bins are added for the sake of uniformity; this ensures that Histograms produced by this unit with a given set of user-specified parameters will be compatible with one another, so that they can be added, multiplied, etc.

Revision 1.1: replaced custom window with GUI builder

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
FreqHist()

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() Initialses information specific to FreqHist.
void	parameterUpdate(java.lang.String name, java.lang.Object value) Used to set each of ReplaceAll's parameters.
void	process() ********************************************* ** USER CODE of FreqHist goes here *** *********************************************
void	reset() Reset's FreqHist

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

FreqHist

public FreqHist()

Method Detail

process

public void process()

********************************************* ** USER CODE of FreqHist goes here *** *********************************************

Specified by:

process in class 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

init

public void init()

Initialses information specific to FreqHist.

Overrides:

init in class Unit

reset

public void reset()

Reset's FreqHist

Overrides:

reset in class Unit

parameterUpdate

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

Used to set each of ReplaceAll'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 FreqHist, 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

getHelpFile

public java.lang.String getHelpFile()