Package gov.nih.mipav.view.dialogs
Class JDialogFuzzyCMeans
- 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.JDialogFuzzyCMeans
 
 
 
 
 
 
 
 
- 
- All Implemented Interfaces:
- AlgorithmInterface,- ScriptableActionInterface,- DialogDefaultsInterface,- ActionDiscovery,- java.awt.event.ActionListener,- java.awt.event.FocusListener,- java.awt.event.ItemListener,- java.awt.event.WindowListener,- java.awt.image.ImageObserver,- java.awt.MenuContainer,- java.io.Serializable,- java.util.EventListener,- javax.accessibility.Accessible,- javax.swing.RootPaneContainer,- javax.swing.WindowConstants
 
 public class JDialogFuzzyCMeans extends JDialogScriptableBase implements AlgorithmInterface, ActionDiscovery, ScriptableActionInterface Dialog to get user input, then call the algorithm.- See Also:
- AlgorithmFuzzyCMeans, Serialized Form
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class gov.nih.mipav.view.dialogs.JDialogBaseJDialogBase.CancelAction, JDialogBase.HelpAction, JDialogBase.OKAction
 - 
Nested classes/interfaces inherited from class javax.swing.JDialogjavax.swing.JDialog.AccessibleJDialog
 - 
Nested classes/interfaces inherited from class java.awt.Dialogjava.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 - 
Nested classes/interfaces inherited from class java.awt.Windowjava.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static intBOTH_FUZZY_HARDDOCUMENT ME!private float[]centroidsDOCUMENT ME!private booleancropBackgroundDOCUMENT ME!private javax.swing.JCheckBoxcropCheckboxDOCUMENT ME!private int[]destExtentsDOCUMENT ME!private floatendTolDOCUMENT ME!private AlgorithmFuzzyCMeansfcmAlgoDOCUMENT ME!static intFUZZY_ONLYDOCUMENT ME!private javax.swing.JRadioButtonfuzzyOnlyDOCUMENT ME!static intHARD_ONLYDOCUMENT ME!private javax.swing.JRadioButtonhardFuzzyBothDOCUMENT ME!private javax.swing.JRadioButtonhardOnlyDOCUMENT ME!private ModelImageimageDOCUMENT ME!private javax.swing.ButtonGroupimageVOIGroupDOCUMENT ME!private javax.swing.JPanelimageVOIPanelDOCUMENT ME!private javax.swing.JLabellabelEndTolDOCUMENT ME!private javax.swing.JLabellabelExpoDOCUMENT ME!private javax.swing.JLabellabelMaxIterDOCUMENT ME!private javax.swing.JLabellabelNClassesDOCUMENT ME!private javax.swing.JLabellabelSignalDOCUMENT ME!private intmaxIterDOCUMENT ME!private intnClassesDOCUMENT ME!private intnPyramidDOCUMENT ME!private intoneJacobiIterDOCUMENT ME!private floatoneSmoothDOCUMENT ME!private booleanoutputGainFieldprivate JCheckBox calcGainFieldCheckbox;.private javax.swing.JPanelparamPanelDOCUMENT ME!private intpresentNumberDOCUMENT ME!private floatqDOCUMENT ME!private booleanregionFlagDOCUMENT ME!private ModelImage[]resultImageDOCUMENT ME!private intresultNumberDOCUMENT ME!private intsegmentationDOCUMENT ME!private javax.swing.ButtonGroupsegmentationGroupDOCUMENT ME!private javax.swing.JPanelsegmentationPanelDOCUMENT ME!private static longserialVersionUIDUse serialVersionUID for interoperability.private javax.swing.JTextFieldtextEndTolDOCUMENT ME!private javax.swing.JTextFieldtextExpoDOCUMENT ME!private javax.swing.JTextFieldtextMaxIterDOCUMENT ME!private javax.swing.JTextFieldtextNClassesDOCUMENT ME!private javax.swing.JTextFieldtextSignalDOCUMENT ME!private floatthresholdDOCUMENT ME!private inttwoJacobiIterDOCUMENT ME!private floattwoSmoothDOCUMENT ME!private javax.swing.JRadioButtonVOIRegionsDOCUMENT ME!private javax.swing.JRadioButtonwholeImageDOCUMENT ME!- 
Fields inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBasedisplayInNewFrame, isComplete, scriptParameters
 - 
Fields inherited from class gov.nih.mipav.view.dialogs.JDialogBaseapplyButton, bar, cancelButton, cancelFlag, closeButton, HELP, helpButton, mainDialogPanel, NEW, OKButton, parentFrame, progressBar, REPLACE, runInSeparateThread, runningScriptFlag, runQuiet, serif12, serif12B, voiManager
 - 
Fields inherited from class javax.swing.JDialogaccessibleContext, rootPane, rootPaneCheckingEnabled
 - 
Fields inherited from class java.awt.ComponentBOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
- 
 - 
Constructor SummaryConstructors Constructor Description JDialogFuzzyCMeans()Empty constructor needed for dynamic instantiation (used during scripting).JDialogFuzzyCMeans(java.awt.Frame theParentFrame, ModelImage im)Creates a new JDialogFuzzyCMeans object.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactionPerformed(java.awt.event.ActionEvent event)Closes dialog box when the OK button is pressed and calls the algorithm.voidalgorithmPerformed(AlgorithmBase algorithm)This method is required if the AlgorithmPerformed interface is implemented.protected voidcallAlgorithm()Once all the necessary variables are set, call the Fuzzy C Means algorithm based on what type of image this is and whether or not there is a separate destination image.ParameterTablecreateInputParameters()Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used insetGUIFromParams()).ParameterTablecreateOutputParameters()Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).protected voiddoPostAlgorithmActions()Store the result image in the script runner's image table now that the action execution is finished.ActionMetadatagetActionMetadata()Return meta-information about this discoverable action for categorization and labeling purposes.private booleangetCentroids()Gets the minimum and maximum of each image and initializes the centroids dialog appropriately.static float[]getDefaultCentroids(ModelImage image, int nClasses, boolean regionFlag, java.util.BitSet regionMask, boolean cropBackground, float threshold)java.lang.StringgetOutputImageName(java.lang.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).ModelImage[]getResultImage()Accessor that returns the image.private voidinit()Sets up the GUI (panels, buttons, etc) and displays it on the screen.booleanisActionComplete()Returns whether the action has successfully completed its execution.voidsetCentroids(float[] centroids)Accessor that sets the centroids.voidsetCrop(boolean flag)Accessor that sets the crop background flag.voidsetEndTol(float scale)Accessor that sets the end tol.protected voidsetGUIFromParams()Set the dialog GUI using the script parameters while running this algorithm as part of a script.voidsetMaxIter(int max)Accessor that sets the max iterations.voidsetNClasses(int classes)Accessor that sets the number of classes.voidsetQ(float scale)Accessor that sets the q variable.voidsetRegionFlag(boolean flag)Accessor that sets the region flag.voidsetSegmentationType(int type)Accessor that sets the segmentation type (BOTH_FUZZY_HARD, FUZZY, or HARD).voidsetThreshold(float scale)Accessor that sets the threshold.private booleansetVariables()Use the GUI results to set up the variables needed to run the algorithm.protected voidstoreParamsFromGUI()Record the parameters just used to run this algorithm in a script.- 
Methods inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBasegetDialogActionString, insertScriptLine, isComplete, scriptRun, setComplete
 - 
Methods inherited from class gov.nih.mipav.view.dialogs.JDialogBasebuildApplyButton, 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, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 - 
Methods inherited from class javax.swing.JDialogaddImpl, 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.DialogaddNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
 - 
Methods inherited from class java.awt.WindowaddPropertyChangeListener, 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.Containeradd, 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.Componentaction, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface gov.nih.mipav.view.dialogs.ActionDiscoveryscriptRun
 - 
Methods inherited from interface gov.nih.mipav.model.scripting.ScriptableActionInterfaceinsertScriptLine, scriptRun
 
- 
 
- 
- 
- 
Field Detail- 
serialVersionUIDprivate static final long serialVersionUID Use serialVersionUID for interoperability.- See Also:
- Constant Field Values
 
 - 
BOTH_FUZZY_HARDpublic static final int BOTH_FUZZY_HARD DOCUMENT ME!- See Also:
- Constant Field Values
 
 - 
FUZZY_ONLYpublic static final int FUZZY_ONLY DOCUMENT ME!- See Also:
- Constant Field Values
 
 - 
HARD_ONLYpublic static final int HARD_ONLY DOCUMENT ME!- See Also:
- Constant Field Values
 
 - 
centroidsprivate float[] centroids DOCUMENT ME!
 - 
cropBackgroundprivate boolean cropBackground DOCUMENT ME!
 - 
cropCheckboxprivate javax.swing.JCheckBox cropCheckbox DOCUMENT ME!
 - 
destExtentsprivate int[] destExtents DOCUMENT ME!
 - 
endTolprivate float endTol DOCUMENT ME!
 - 
fcmAlgoprivate AlgorithmFuzzyCMeans fcmAlgo DOCUMENT ME!
 - 
fuzzyOnlyprivate javax.swing.JRadioButton fuzzyOnly DOCUMENT ME!
 - 
hardFuzzyBothprivate javax.swing.JRadioButton hardFuzzyBoth DOCUMENT ME!
 - 
hardOnlyprivate javax.swing.JRadioButton hardOnly DOCUMENT ME!
 - 
imageprivate ModelImage image DOCUMENT ME!
 - 
imageVOIGroupprivate javax.swing.ButtonGroup imageVOIGroup DOCUMENT ME!
 - 
imageVOIPanelprivate javax.swing.JPanel imageVOIPanel DOCUMENT ME!
 - 
labelEndTolprivate javax.swing.JLabel labelEndTol DOCUMENT ME!
 - 
labelExpoprivate javax.swing.JLabel labelExpo DOCUMENT ME!
 - 
labelMaxIterprivate javax.swing.JLabel labelMaxIter DOCUMENT ME!
 - 
labelNClassesprivate javax.swing.JLabel labelNClasses DOCUMENT ME!
 - 
labelSignalprivate javax.swing.JLabel labelSignal DOCUMENT ME!
 - 
maxIterprivate int maxIter DOCUMENT ME!
 - 
nClassesprivate int nClasses DOCUMENT ME!
 - 
nPyramidprivate int nPyramid DOCUMENT ME!
 - 
oneJacobiIterprivate int oneJacobiIter DOCUMENT ME!
 - 
oneSmoothprivate float oneSmooth DOCUMENT ME!
 - 
outputGainFieldprivate boolean outputGainField private JCheckBox calcGainFieldCheckbox;.
 - 
paramPanelprivate javax.swing.JPanel paramPanel DOCUMENT ME!
 - 
presentNumberprivate int presentNumber DOCUMENT ME!
 - 
qprivate float q DOCUMENT ME!
 - 
regionFlagprivate boolean regionFlag DOCUMENT ME!
 - 
resultImageprivate ModelImage[] resultImage DOCUMENT ME!
 - 
resultNumberprivate int resultNumber DOCUMENT ME!
 - 
segmentationprivate int segmentation DOCUMENT ME!
 - 
segmentationGroupprivate javax.swing.ButtonGroup segmentationGroup DOCUMENT ME!
 - 
segmentationPanelprivate javax.swing.JPanel segmentationPanel DOCUMENT ME!
 - 
textEndTolprivate javax.swing.JTextField textEndTol DOCUMENT ME!
 - 
textExpoprivate javax.swing.JTextField textExpo DOCUMENT ME!
 - 
textMaxIterprivate javax.swing.JTextField textMaxIter DOCUMENT ME!
 - 
textNClassesprivate javax.swing.JTextField textNClasses DOCUMENT ME!
 - 
textSignalprivate javax.swing.JTextField textSignal DOCUMENT ME!
 - 
thresholdprivate float threshold DOCUMENT ME!
 - 
twoJacobiIterprivate int twoJacobiIter DOCUMENT ME!
 - 
twoSmoothprivate float twoSmooth DOCUMENT ME!
 - 
VOIRegionsprivate javax.swing.JRadioButton VOIRegions DOCUMENT ME!
 - 
wholeImageprivate javax.swing.JRadioButton wholeImage DOCUMENT ME!
 
- 
 - 
Constructor Detail- 
JDialogFuzzyCMeanspublic JDialogFuzzyCMeans() Empty constructor needed for dynamic instantiation (used during scripting).
 - 
JDialogFuzzyCMeanspublic JDialogFuzzyCMeans(java.awt.Frame theParentFrame, ModelImage im)Creates a new JDialogFuzzyCMeans object.- Parameters:
- theParentFrame- parent frame
- im- source image
 
 
- 
 - 
Method Detail- 
actionPerformedpublic void actionPerformed(java.awt.event.ActionEvent event) Closes dialog box when the OK button is pressed and calls the algorithm.- Specified by:
- actionPerformedin interface- java.awt.event.ActionListener
- Overrides:
- actionPerformedin class- JDialogBase
- Parameters:
- event- Event that triggers function.
 
 - 
algorithmPerformedpublic void algorithmPerformed(AlgorithmBase algorithm) This method is required if the AlgorithmPerformed interface is implemented. It is called by the algorithms when it has completed or failed to to complete, so that the dialog can be display the result image and/or clean up.- Specified by:
- algorithmPerformedin interface- AlgorithmInterface
- Parameters:
- algorithm- Algorithm that caused the event.
 
 - 
getResultImagepublic ModelImage[] getResultImage() Accessor that returns the image.- Returns:
- The result image.
 
 - 
setCentroidspublic void setCentroids(float[] centroids) Accessor that sets the centroids.- Parameters:
- centroids- Value to set centroids to.
 
 - 
setCroppublic void setCrop(boolean flag) Accessor that sets the crop background flag.- Parameters:
- flag-- trueindicates crop the background,- falseotherwise.
 
 - 
setEndTolpublic void setEndTol(float scale) Accessor that sets the end tol.- Parameters:
- scale- Value to set end tol to.
 
 - 
setMaxIterpublic void setMaxIter(int max) Accessor that sets the max iterations.- Parameters:
- max- The max iterations
 
 - 
setNClassespublic void setNClasses(int classes) Accessor that sets the number of classes.- Parameters:
- classes- The number of classes.
 
 - 
setQpublic void setQ(float scale) Accessor that sets the q variable.- Parameters:
- scale- Value to set q variable to.
 
 - 
setRegionFlagpublic void setRegionFlag(boolean flag) Accessor that sets the region flag.- Parameters:
- flag-- trueindicates the whole image is blurred,- falseindicates a region.
 
 - 
setSegmentationTypepublic void setSegmentationType(int type) Accessor that sets the segmentation type (BOTH_FUZZY_HARD, FUZZY, or HARD).- Parameters:
- type- The segmentation type.
 
 - 
setThresholdpublic void setThreshold(float scale) Accessor that sets the threshold.- Parameters:
- scale- Value to set the threshold to.
 
 - 
callAlgorithmprotected void callAlgorithm() Once all the necessary variables are set, call the Fuzzy C Means algorithm based on what type of image this is and whether or not there is a separate destination image.- Specified by:
- callAlgorithmin class- JDialogScriptableBase
 
 - 
doPostAlgorithmActionsprotected void doPostAlgorithmActions() Store the result image in the script runner's image table now that the action execution is finished.- Overrides:
- doPostAlgorithmActionsin class- JDialogScriptableBase
 
 - 
setGUIFromParamsprotected void setGUIFromParams() Set the dialog GUI using the script parameters while running this algorithm as part of a script.- Specified by:
- setGUIFromParamsin class- JDialogScriptableBase
 
 - 
storeParamsFromGUIprotected void storeParamsFromGUI() throws ParserExceptionRecord the parameters just used to run this algorithm in a script.- Specified by:
- storeParamsFromGUIin class- JDialogScriptableBase
- Throws:
- ParserException- If there is a problem creating/recording the new parameters.
 
 - 
getDefaultCentroidspublic static float[] getDefaultCentroids(ModelImage image, int nClasses, boolean regionFlag, java.util.BitSet regionMask, boolean cropBackground, float threshold) 
 - 
getCentroidsprivate boolean getCentroids() Gets the minimum and maximum of each image and initializes the centroids dialog appropriately.- Returns:
- Flag indicating a successful get.
 
 - 
initprivate void init() Sets up the GUI (panels, buttons, etc) and displays it on the screen.
 - 
setVariablesprivate boolean setVariables() Use the GUI results to set up the variables needed to run the algorithm.- Returns:
- trueif parameters set successfully,- falseotherwise.
 
 - 
getActionMetadatapublic ActionMetadata getActionMetadata() Return meta-information about this discoverable action for categorization and labeling purposes.- Specified by:
- getActionMetadatain interface- ActionDiscovery
- Returns:
- Metadata for this action.
 
 - 
createInputParameterspublic ParameterTable createInputParameters() Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used insetGUIFromParams()).- Specified by:
- createInputParametersin interface- ActionDiscovery
- Returns:
- A parameter table listing the inputs of this algorithm.
 
 - 
createOutputParameterspublic ParameterTable createOutputParameters() Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).- Specified by:
- createOutputParametersin interface- ActionDiscovery
- Returns:
- A parameter table listing the outputs of this algorithm.
 
 - 
getOutputImageNamepublic java.lang.String getOutputImageName(java.lang.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).- Specified by:
- getOutputImageNamein 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.
 
 - 
isActionCompletepublic boolean isActionComplete() Returns whether the action has successfully completed its execution.- Specified by:
- isActionCompletein interface- ActionDiscovery
- Returns:
- True, if the action is complete. False, if the action failed or is still running.
 
 
- 
 
-