common.processing

Class Complexify

java.lang.Object

org.trianacode.taskgraph.Unit

common.processing.Complexify

public class Complexify
extends Unit

A Complexify unit to join two input data sets into a single complex set. The (real part of the) first input is the real part of the output, and the (real part of the) second input is the imaginary part of the output. The two data sets must be compatible. If they are SampleSets, then the output is a ComplexSampleSet; if they are Spectrums then the output is a ComplexSpectrum. For any other GraphType the data type is copied to a similar type. For a Const a new complex Const is output. If the inputs have imaginary parts, these are ignored. If the second input node is absent, or if there is no data at that node, then a complex output is created with zero imaginary part. If there is no data at the first input node, then a complex output is created with zero real part. If there is no data at either node, then the unit fails.

This version conforms to Triana Type 2 data type conventions.

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

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 Complexify.
void	process() ********************************************* ** USER CODE of Complexify goes here *** *********************************************
void	reset() Resets Complexify
void	saveParameters() Saves Complexify's parameters to the parameter file.
void	setParameter(java.lang.String name, java.lang.String value) Loads Complexify's parameters of from the parameter file.

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

Complexify

public Complexify()

Method Detail

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

process

public void process()

********************************************* ** USER CODE of Complexify goes here *** *********************************************

Specified by:

process in class Unit

init

public void init()

Initialses information specific to Complexify.

Overrides:

init in class Unit

reset

public void reset()

Resets Complexify

Overrides:

reset in class Unit

saveParameters

public void saveParameters()

Saves Complexify's parameters to the parameter file.

setParameter

public void setParameter(java.lang.String name,
                java.lang.String value)

Loads Complexify's parameters of from the parameter file.

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

a string containing the names of the types output from Compare, each separated by a white space.

getHelpFile

public java.lang.String getHelpFile()