math.functions

Class ArcTanh

java.lang.Object

org.trianacode.taskgraph.Unit

math.functions.ArcTanh

public class ArcTanh
extends Unit

An ArcTanh unit to compute the inverse hyperbolic tangent of the elements of an input data object. The input data can be either GraphType or Const. The function is applied to each element of each arithmetic dependent-data array of an input GraphType, regardless of dimensionality.

The input data arrays can be real or complex. If the data are real and in the range [-1, 1], then the returned data set will be real. If the data are real but at least one has absolute value greater than 1.0, or if the input data are complex, then the output data will be complex. If necessary input SampleSet and Spectrum sets will be converted to ComplexSampleSet and ComplexSpectrum on output.

This Unit obeys the conventions of Triana Type 2 data types.

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

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.awt.Window	getParameterWindow()
java.lang.String	getPopUpDescription() This returns a brief! description of what the unit does.
void	init() Initialses information specific to ArcTanh.
void	process() ********************************************* ** USER CODE of ArcTanh goes here *** *********************************************
void	reset() Resets ArcTanh
void	saveParameters() Saves ArcTanh's parameters to the parameter file.
void	setParameter(java.lang.String name, java.lang.String value) Loads ArcTanh'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

ArcTanh

public ArcTanh()

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 ArcTanh goes here *** *********************************************

Specified by:

process in class Unit

init

public void init()

Initialses information specific to ArcTanh.

Overrides:

init in class Unit

reset

public void reset()

Resets ArcTanh

Overrides:

reset in class Unit

saveParameters

public void saveParameters()

Saves ArcTanh's parameters to the parameter file.

setParameter

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

Loads ArcTanh'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 ArcTanh, 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()

getParameterWindow

public java.awt.Window getParameterWindow()

Returns:

ArcTanh's parameter window sp that Triana can move and display it.