Package gov.nih.mipav.view.dialogs

Class JDialogVOIHausdorffDistance

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

gov.nih.mipav.view.dialogs.JDialogBase

gov.nih.mipav.view.dialogs.JDialogScriptableBase

gov.nih.mipav.view.dialogs.JDialogVOIHausdorffDistance

All Implemented Interfaces:

AlgorithmInterface, ScriptableActionInterface, VOIVectorListener, VOIStatisticList, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TreeSelectionListener, RootPaneContainer, WindowConstants

public class JDialogVOIHausdorffDistance
extends JDialogScriptableBase
implements AlgorithmInterface, VOIStatisticList, VOIVectorListener, TreeSelectionListener, ActionDiscovery

Author:

ilb This dialog and utility allows for calculating the Hausdorff distance between 2 VOIs.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JDialogVOIHausdorffDistance.JPanelAddRemoveVOI	controllas the lists between left and right side.
class	JDialogVOIHausdorffDistance.VOIHighlighter	An active listener for VOIEvents and ListSelectionEvents, this class will ensure the selected state of the VOI and its name in a dialog's list is the same.
private class	JDialogVOIHausdorffDistance.VOITreeRenderer

Nested classes/interfaces inherited from class gov.nih.mipav.view.dialogs.JDialogBase

JDialogBase.CancelAction, JDialogBase.HelpAction, JDialogBase.OKAction

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private JDialogVOIHausdorffDistance.JPanelAddRemoveVOI	addremove	Panel to push/pull VOIs from full list to selectable list.
private AlgorithmVOIHausdorffDistance	alg	algorithm
protected JTabbedPane	everything	Tabbed pane that holds all components.
private Border	frameBorder
private JDialogVOIHausdorffDistance.VOIHighlighter	highlighter	Operator to provide listener access... could be done by /this/
private static Icon	ICON_LINE	DOCUMENT ME!
private static Icon	ICON_MEDICAL_FRAME	DOCUMENT ME!
private static Icon	ICON_POINT	DOCUMENT ME!
private static Icon	ICON_POLYGON	DOCUMENT ME!
private static Icon	ICON_POLYLINE	DOCUMENT ME!
private static Icon	ICON_PROTRACTOR	DOCUMENT ME!
private static Icon	ICON_X_AXIS	DOCUMENT ME!
private static Icon	ICON_Y_AXIS	DOCUMENT ME!
private static Icon	ICON_Z_AXIS	DOCUMENT ME!
protected ModelImage	image	image and cloned image
(package private) int	index
private JScrollPane	jsp
(package private) int	logicalOperation
(package private) ViewVOIVector	processList
private DefaultMutableTreeNode	selectedRoot	DOCUMENT ME!
private VOI	selectedVOI
private DefaultTreeModel	selectedVOIModel	The tree of VOIs, composed of an image with children VOIs
private JTree	selectedVoiTree
private DefaultMutableTreeNode	sourceRoot	DOCUMENT ME!
private DefaultTreeModel	sourceVoiModel	The tree of VOIs, composed of an image with children VOIs
private JTree	sourceVoiTree	The graphical representation of voiModel
private boolean	treeSelectionChange
private boolean	updateTree
protected ViewUserInterface	userInterface
protected VOIHandlerInterface	voiHandler

Fields inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBase

displayInNewFrame, isComplete, scriptParameters

Fields inherited from class gov.nih.mipav.view.dialogs.JDialogBase

applyButton, bar, cancelButton, cancelFlag, closeButton, HELP, helpButton, mainDialogPanel, NEW, OKButton, parentFrame, progressBar, REPLACE, runInSeparateThread, runningScriptFlag, runQuiet, serif12, serif12B, voiManager

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface gov.nih.mipav.model.structures.VOIStatisticList

areaDescription, asymmetryIndexDescription, avgIntensity, axisDescription, circularityDescription, deviationDescription, eccentricityDescription, fractalDimensionBoxCountDescription, fractalDimensionEuclideanDistanceDescription, geometricCenterDescription, invariantMoment1Description, invariantMoment2Description, invariantMoment3Description, invariantMoment4Description, invariantMoment5Description, invariantMoment6Description, invariantMoment7Description, kurtosisDescription, largestDistanceDescription, largestSliceDistanceDescription, majorAxisDescription, massCenterDescription, maxIntensity, maxWidthDescription, meanCurvatureDescription, meanNegativeCurvatureDescription, median, minIntensity, minorAxisDescription, mode, modeCount, numberOfIndentationsCurvatureDescription, numberOfIndentationsHullDescription, numberOfStatistics, perimeterDescription, quantityDescription, skewnessDescription, solidityDescription, statisticDescription, stdDevCurvatureDescription, sumIntensities, surfaceAreaDescription, volumeDescription

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
JDialogVOIHausdorffDistance(VOIHandlerInterface voiHandler, VOIVector voiList)	constructor

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	addedVOI(VOIVectorEvent voiEvent)	resets the volumes list to the current VOIVector. adds the highlighter to the new VOI.
void	algorithmPerformed(AlgorithmBase algorithm)	Called after an algorithm this listener is registered to exits (maybe successfully, maybe not).
protected void	buildDialog(VOIVector voiList)	Builds the dialog
protected JPanel	buildOKCancelPanel()	creates the panel which consists of the OKAY button and the Cancel button.
private JPanel	buildSelectedListing()	creates the visual display in which to list all selected directories in the directory tree.
private JPanel	buildSourceListingPanel(VOIVector VOIlist)	Creates the panel holding the directory tree.
private JPanel	buildSourcePanel(VOIVector VOIlist)	creates the source panel which consists of the directory line, the browse button, and a check box approving the anonymize in sub-directories.
protected JPanel	buildVOIPanel(VOIVector VOIlist)	creates the source panel for the VOI tab which consists of the directory line, the browse button, and a check box approving the anonymize in sub-directories.
protected JTree	buildVOITree()	DOCUMENT ME!
protected void	callAlgorithm()	Starts the algorithm.
protected void	cleanUpAndDispose()	Clean up some things done by the dialog which may affect other parts of MIPAV.
ParameterTable	createInputParameters()	Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in invalid reference #setGUIFromParams() ).
ParameterTable	createOutputParameters()	Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).
ActionMetadata	getActionMetadata()	Return meta-information about this discoverable action for categorization and labeling purposes.
String	getOutputImageName(String imageParamName)	Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).
boolean	isActionComplete()	Returns whether the action has successfully completed its execution.
private void	printTree(TreeModel model, Object parent)
void	removedVOI(VOIVectorEvent voiEvent)	resets the volumes list to the current VOIVector. removes the highlighter from the removed VOI.
protected void	setGUIFromParams()	Set the dialog GUI using the script parameters while running this algorithm as part of a script.
protected void	storeParamsFromGUI()	Record the parameters just used to run this algorithm in a script.
void	updateTree()
void	updateVOI(VOI _voi, ModelImage img)	Updates the dialog based on the VOI passed in.
void	valueChanged(TreeSelectionEvent e)	Updates the ViewJFrameImage when a VOI/contour is selected.
void	vectorSelected(VOIVectorEvent voiEvent)	un-implemented.
void	windowClosing(WindowEvent event)	Disposes of error dialog, then frame.

Methods inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBase

doPostAlgorithmActions, getDialogActionString, insertScriptLine, isComplete, scriptRun, setComplete

Methods inherited from class gov.nih.mipav.view.dialogs.JDialogBase

buildApplyButton, buildButtons, buildCancelButton, buildCancelButton, buildCloseButton, buildHelpButton, buildImageComboBox, buildOKButton, buildOKButton, buildOKCancelButtons, buildTitledBorder, buildTitledBorder, createLabel, createProgressBar, createProgressBar, createTextField, focusGained, focusLost, getDialogName, isCancelled, isQuietRunning, isRunInSeparateThread, isScriptRunning, itemStateChanged, loadDefaults, loadDefaults, makeImageName, makeString, openNewFrame, saveDefaults, saveDefaults, setLeftHandSystem, setQuietRunning, setScriptRunning, setSeparateThread, setVisible, setVisible, setVisibleMenuBar, setVisibleStandard, setVOIManager, setWCSystem, testParameter, testParameterMin, updateFFTFileInfo, updateFileInfo, updateFileInfoOtherModality, updateFileInfoStatic, updateFileInfoStatic, updateFileTypeInfo, updateFileTypeInfo, windowActivated, windowClosed, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nih.mipav.view.dialogs.ActionDiscovery

scriptRun

Field Details

image

protected ModelImage image

image and cloned image

userInterface

protected ViewUserInterface userInterface

everything

protected JTabbedPane everything

Tabbed pane that holds all components.

highlighter

private JDialogVOIHausdorffDistance.VOIHighlighter highlighter

Operator to provide listener access... could be done by /this/

addremove

private JDialogVOIHausdorffDistance.JPanelAddRemoveVOI addremove

Panel to push/pull VOIs from full list to selectable list.

alg

private AlgorithmVOIHausdorffDistance alg

algorithm

sourceRoot

private DefaultMutableTreeNode sourceRoot

DOCUMENT ME!

selectedRoot

private DefaultMutableTreeNode selectedRoot

DOCUMENT ME!

sourceVoiModel

private DefaultTreeModel sourceVoiModel

The tree of VOIs, composed of an image with children VOIs

selectedVOIModel

private DefaultTreeModel selectedVOIModel

The tree of VOIs, composed of an image with children VOIs

sourceVoiTree

private JTree sourceVoiTree

The graphical representation of voiModel

selectedVoiTree

private JTree selectedVoiTree

ICON_POLYGON

private static Icon ICON_POLYGON

DOCUMENT ME!

ICON_POLYLINE

private static Icon ICON_POLYLINE

DOCUMENT ME!

ICON_POINT

private static Icon ICON_POINT

DOCUMENT ME!

ICON_LINE

private static Icon ICON_LINE

DOCUMENT ME!

ICON_MEDICAL_FRAME

private static Icon ICON_MEDICAL_FRAME

DOCUMENT ME!

ICON_X_AXIS

private static Icon ICON_X_AXIS

DOCUMENT ME!

ICON_Y_AXIS

private static Icon ICON_Y_AXIS

DOCUMENT ME!

ICON_Z_AXIS

private static Icon ICON_Z_AXIS

DOCUMENT ME!

ICON_PROTRACTOR

private static Icon ICON_PROTRACTOR

DOCUMENT ME!

frameBorder

private Border frameBorder

jsp

private JScrollPane jsp

treeSelectionChange

private boolean treeSelectionChange

updateTree

private boolean updateTree

voiHandler

protected VOIHandlerInterface voiHandler

selectedVOI

private VOI selectedVOI

index

int index

logicalOperation

int logicalOperation

processList

ViewVOIVector processList

Constructor Details

JDialogVOIHausdorffDistance

public JDialogVOIHausdorffDistance(VOIHandlerInterface voiHandler,
 VOIVector voiList)

constructor

Parameters:

voiList -

Method Details

cleanUpAndDispose

protected void cleanUpAndDispose()

Clean up some things done by the dialog which may affect other parts of MIPAV.

buildDialog

protected void buildDialog(VOIVector voiList)

Builds the dialog

Parameters:

voiList -

buildOKCancelPanel

protected JPanel buildOKCancelPanel()

creates the panel which consists of the OKAY button and the Cancel button.

vectorSelected

public void vectorSelected(VOIVectorEvent voiEvent)

un-implemented.

Specified by:

vectorSelected in interface VOIVectorListener

Parameters:

voiEvent - DOCUMENT ME!

addedVOI

public void addedVOI(VOIVectorEvent voiEvent)

resets the volumes list to the current VOIVector. adds the highlighter to the new VOI.

Specified by:

addedVOI in interface VOIVectorListener

Parameters:

voiEvent - DOCUMENT ME!

removedVOI

public void removedVOI(VOIVectorEvent voiEvent)

resets the volumes list to the current VOIVector. removes the highlighter from the removed VOI.

Specified by:

removedVOI in interface VOIVectorListener

Parameters:

voiEvent - DOCUMENT ME!

buildSourceListingPanel

private JPanel buildSourceListingPanel(VOIVector VOIlist)

Creates the panel holding the directory tree.

Parameters:

VOIlist - DOCUMENT ME!

Returns:

Panel.

updateTree

public void updateTree()

buildVOITree

protected JTree buildVOITree()

DOCUMENT ME!

buildSourcePanel

private JPanel buildSourcePanel(VOIVector VOIlist)

creates the source panel which consists of the directory line, the browse button, and a check box approving the anonymize in sub-directories.

Parameters:

VOIlist - DOCUMENT ME!

Returns:

DOCUMENT ME!

buildSelectedListing

private JPanel buildSelectedListing()

creates the visual display in which to list all selected directories in the directory tree. The panel is 240 pixels wide though that is supposed to be the minimum size

Returns:

the panel which is to hold the list of selected items

buildVOIPanel

protected JPanel buildVOIPanel(VOIVector VOIlist)

creates the source panel for the VOI tab which consists of the directory line, the browse button, and a check box approving the anonymize in sub-directories. Also includes the file-format selection for the output file.

Parameters:

VOIlist - DOCUMENT ME!

Returns:

DOCUMENT ME!

callAlgorithm

protected void callAlgorithm()

Description copied from class: JDialogScriptableBase

Starts the algorithm. Already exists in most algorithm dialogs. Should be called during scripted execution and regular operation.

Specified by:

callAlgorithm in class JDialogScriptableBase

setGUIFromParams

protected void setGUIFromParams()

Description copied from class: JDialogScriptableBase

Set the dialog GUI using the script parameters while running this algorithm as part of a script.

Specified by:

setGUIFromParams in class JDialogScriptableBase

storeParamsFromGUI

protected void storeParamsFromGUI()
                           throws ParserException

Description copied from class: JDialogScriptableBase

Record the parameters just used to run this algorithm in a script.

Specified by:

storeParamsFromGUI in class JDialogScriptableBase

Throws:

ParserException - If there is a problem creating/recording the new parameters.

algorithmPerformed

public void algorithmPerformed(AlgorithmBase algorithm)

Description copied from interface: AlgorithmInterface

Called after an algorithm this listener is registered to exits (maybe successfully, maybe not). If the algorithm is run in a separate thread, this call will be made within that thread. If not, this call will be made from that same, shared thread.

Specified by:

algorithmPerformed in interface AlgorithmInterface

Parameters:

algorithm - the algorithm which has just completed

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class JDialogBase

windowClosing

public void windowClosing(WindowEvent event)

Description copied from class: JDialogBase

Disposes of error dialog, then frame. Sets cancelled to true.

Specified by:

windowClosing in interface WindowListener

Overrides:

windowClosing in class JDialogBase

Parameters:

event - WindowEvent

printTree

private void printTree(TreeModel model,
 Object parent)

valueChanged

public void valueChanged(TreeSelectionEvent e)

Updates the ViewJFrameImage when a VOI/contour is selected.

Specified by:

valueChanged in interface TreeSelectionListener

Parameters:

e - TreeSelectionEvent

updateVOI

public void updateVOI(VOI _voi,
 ModelImage img)

Updates the dialog based on the VOI passed in.

Parameters:

_voi - VOI whose properties we want to calculate.

img - Image where voi is to be updated

createInputParameters

public ParameterTable createInputParameters()

Description copied from interface: ActionDiscovery

Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in

invalid reference

#setGUIFromParams()

).

Specified by:

createInputParameters in interface ActionDiscovery

Returns:

A parameter table listing the inputs of this algorithm.

createOutputParameters

public ParameterTable createOutputParameters()

Description copied from interface: ActionDiscovery

Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).

Specified by:

createOutputParameters in interface ActionDiscovery

Returns:

A parameter table listing the outputs of this algorithm.

getActionMetadata

public ActionMetadata getActionMetadata()

Description copied from interface: ActionDiscovery

Return meta-information about this discoverable action for categorization and labeling purposes.

Specified by:

getActionMetadata in interface ActionDiscovery

Returns:

Metadata for this action.

getOutputImageName

public String getOutputImageName(String imageParamName)

Description copied from interface: ActionDiscovery

Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).

Specified by:

getOutputImageName in interface ActionDiscovery

Parameters:

imageParamName - The output image parameter label for which to get the image name.

Returns:

The image name of the requested output image parameter label.

isActionComplete

public boolean isActionComplete()

Description copied from interface: ActionDiscovery

Returns whether the action has successfully completed its execution.

Specified by:

isActionComplete in interface ActionDiscovery

Returns:

True, if the action is complete. False, if the action failed or is still running.