Package gov.nih.mipav.view.dialogs

Class JDialogLowerCompletion

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.JDialogLowerCompletion
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogLowerCompletion extends JDialogScriptableBase implements AlgorithmInterface, ActionDiscovery, ScriptableActionInterface
Dialog to get user input, then call the algorithm.
Version:
0.1 September 12, 2016
Author:
William Gandler
See Also:

  • Field Details

    • image

      private ModelImage image
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • neighborPanel

      private JPanel neighborPanel
      DOCUMENT ME!

    • lcAlgo

      private AlgorithmLowerCompletion lcAlgo
      DOCUMENT ME!

    • numNeighbor

      private int numNeighbor

    • neighborGroup

      private ButtonGroup neighborGroup

    • fourButton

      private JRadioButton fourButton

    • eightButton

      private JRadioButton eightButton

    • sixButton

      private JRadioButton sixButton

    • eighteenButton

      private JRadioButton eighteenButton

    • twentySixButton

      private JRadioButton twentySixButton

    • limitBins

      private boolean limitBins

    • labelBins

      private JLabel labelBins

    • textBins

      private JTextField textBins

    • binCheckBox

      private JCheckBox binCheckBox

    • binNumber

      private int binNumber

  • Constructor Details

    • JDialogLowerCompletion

      public JDialogLowerCompletion()
      Empty constructor needed for dynamic instantiation.

    • JDialogLowerCompletion

      public JDialogLowerCompletion(Frame theParentFrame, ModelImage im)
      Creates a new JDialogLowerCompletion object.
      Parameters:
      theParentFrame - Parent frame.
      im - Source image.

  • Method Details

    • actionPerformed

      public void actionPerformed(ActionEvent event)
      Closes dialog box when the OK button is pressed and calls the algorithm.
      Specified by:
      actionPerformed in interface ActionListener
      Overrides:
      actionPerformed in class JDialogBase
      Parameters:
      event - Event that triggers function.

    • algorithmPerformed

      public void algorithmPerformed(AlgorithmBase algorithm)
      This method is required if the AlgorithmPerformed interface is implemented. It is called by the algorithm 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:
      algorithmPerformed in interface AlgorithmInterface
      Parameters:
      algorithm - Algorithm that caused the event.

    • getResultImage

      public ModelImage getResultImage()
      Accessor that returns the image.
      Returns:
      The result image.

    • setNumNeighbor

      public void setNumNeighbor(int numNeighbor)
      Accessor that sets numNeighbor.
      Parameters:
      numNeighbor -

    • setLimitBins

      public void setLimitBins(boolean limitBins)
      Parameters:
      limitBins -

    • setBinNumber

      public void setBinNumber(int binNumber)
      Parameters:
      binNumber -

    • callAlgorithm

      protected void callAlgorithm()
      Once all the necessary variables are set, call the Lower Completion algorithm.
      Specified by:
      callAlgorithm in class JDialogScriptableBase

    • doPostAlgorithmActions

      protected void doPostAlgorithmActions()
      Store the result image in the script runner's image table now that the action execution is finished.
      Overrides:
      doPostAlgorithmActions in class JDialogScriptableBase

    • setGUIFromParams

      protected void setGUIFromParams()
      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
      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.

    • init

      private void init()
      Sets up the GUI (panels, buttons, etc) and displays it on the screen.

    • setVariables

      private boolean setVariables()
      Use the GUI results to set up the variables needed to run the algorithm.
      Returns:
      true if parameters set successfully, false otherwise.

    • getActionMetadata

      public ActionMetadata getActionMetadata()
      Return meta-information about this discoverable action for categorization and labeling purposes.
      Specified by:
      getActionMetadata in interface ActionDiscovery
      Returns:
      Metadata for this action.

    • createInputParameters

      public ParameterTable createInputParameters()
      Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in setGUIFromParams()).
      Specified by:
      createInputParameters in interface ActionDiscovery
      Returns:
      A parameter table listing the inputs of this algorithm.

    • createOutputParameters

      public ParameterTable createOutputParameters()
      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.

    • getOutputImageName

      public 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).
      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()
      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.