math.functions

Class PhaseCont

java.lang.Object

org.trianacode.taskgraph.Unit

math.functions.PhaseCont

public class PhaseCont
extends Unit

A PhaseCont unit to smooth out jumps of 2 Pi in an inut sequence of real data representing a phase angle, so that the angle moves smoothly to values larger than Pi or smaller than -Pi.

Most functions constrain the phase of a complex number or the angle of a vector in the 2D plane to a principal range of (-Pi, Pi), for example the function atan2. This Unit takes the output of such angle-finders and makes it continuous outside the principal range by looking for big discontinuities (where the phase jumps from near -Pi to near +Pi, for example, and adds an appropriate multiple of 2*Pi to the angle to eliminate the jump.

PhaseCont does not find the original phase. It takes output from a Unit that does and smooths the phase. PhaseCont should only be used when one expects a smoothly changing phase from one element to the next; it will not make sensible answers when applied, for example, to phase noise.

This method can be used to find winding numbers of curves around the origin.

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

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 PhaseCont.
void	parameterUpdate(java.lang.String name, java.lang.Object value) Used to set each of PhaseCont's parameters.
void	process() ********************************************* ** USER CODE of PhaseCont goes here *** *********************************************
void	reset() Called when the reset button is pressed within the MainTriana Window
void	stopping() Called when the stop button is pressed within the MainTriana Window
void	updateWidgetFor(java.lang.String name) Don't need to use this for GUI Builder units as everthing is updated by triana automatically

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PhaseCont

public PhaseCont()

Method Detail

process

public void process()
             throws java.lang.Exception

********************************************* ** USER CODE of PhaseCont goes here *** *********************************************

Specified by:

process in class Unit

Throws:

java.lang.Exception

init

public void init()

Initialses information specific to PhaseCont.

Overrides:

init in class Unit

reset

public void reset()

Called when the reset button is pressed within the MainTriana Window

Overrides:

reset in class Unit

stopping

public void stopping()

Called when the stop button is pressed within the MainTriana Window

Overrides:

stopping in class Unit

parameterUpdate

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

Used to set each of PhaseCont's parameters.

Overrides:

parameterUpdate in class Unit

updateWidgetFor

public void updateWidgetFor(java.lang.String name)

Don't need to use this for GUI Builder units as everthing is updated by triana automatically

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 PhaseCont, 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()