Package gov.nih.mipav.view.dialogs

Class JDialogBorderClearing

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.JDialogBorderClearing
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogBorderClearing extends JDialogScriptableBase implements AlgorithmInterface, ActionDiscovery
Dialog to get user input, then call the algorithm. The user has the option to generate a new image or replace the source image. In addition the user selects if the algorithm is applied to whole image or to the VOI regions. It should be noted that the algorithms are executed in their own threads.
Version:
1.0 October 14, 2106
Author:
William Gandler
See Also:

  • Field Details

    • comboBoxKernel

      private JComboBox comboBoxKernel
      DOCUMENT ME!

    • do25D

      private boolean do25D
      DOCUMENT ME!

    • borderClearAlgo25D

      private AlgorithmMorphology25D borderClearAlgo25D
      DOCUMENT ME!

    • borderClearAlgo2D

      private AlgorithmMorphology2D borderClearAlgo2D
      DOCUMENT ME!

    • borderClearAlgo3D

      private AlgorithmMorphology3D borderClearAlgo3D
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • image25D

      private JCheckBox image25D
      DOCUMENT ME!

    • kernel

      private int kernel
      DOCUMENT ME!

    • kernelSize

      private float kernelSize
      DOCUMENT ME!

    • labelKernel

      private JLabel labelKernel
      DOCUMENT ME!

    • maskPanel

      private JPanel maskPanel
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

    • outputPanel

      private JPanelAlgorithmOutputOptions outputPanel

    • destinationPanel

      private JPanel destinationPanel

    • destinationGroup

      private ButtonGroup destinationGroup

    • newImage

      private JRadioButton newImage

    • replaceImage

      private JRadioButton replaceImage

    • processPanel

      private JPanel processPanel

    • displayLoc

      private int displayLoc

  • Constructor Details

    • JDialogBorderClearing

      public JDialogBorderClearing()
      Empty constructor needed for dynamic instantiation (used during scripting).

    • JDialogBorderClearing

      public JDialogBorderClearing(Frame theParentFrame, ModelImage im)
      Creates new Border clearing dialog.
      Parameters:
      theParentFrame - Parent frame
      im - Source image

  • Method Details

    • 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.

    • 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

    • doPostAlgorithmActions

      protected void doPostAlgorithmActions()
      Used to perform actions after the execution of the algorithm is completed (e.g., put the result image in the image table). Defaults to no action, override to actually have it do something.
      Overrides:
      doPostAlgorithmActions in class JDialogScriptableBase

    • 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 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:
      algorithmPerformed in interface AlgorithmInterface
      Parameters:
      algorithm - Algorithm that caused the event.

    • getResultImage

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

    • itemStateChanged

      public void itemStateChanged(ItemEvent event)
      Sets text fields enabled depending upon which item in the combo box is selected.
      Specified by:
      itemStateChanged in interface ItemListener
      Overrides:
      itemStateChanged in class JDialogBase
      Parameters:
      event - DOCUMENT ME!

    • setImage25D

      public void setImage25D(boolean b)
      Process the image in 2.5D.
      Parameters:
      b - whether to do 2.5D morphology

    • setKernelSize

      public void setKernelSize(float s)
      Accessor that sets the kernel size.
      Parameters:
      s - the desired kernel size

    • setKernelType

      public void setKernelType(int krnl)
      Accessor that sets the kernel type to use.
      Parameters:
      krnl - the kernel type to use (either AlgorithmMorphology2D.CONNECTED4, AlgorithmMorphology2D.CONNECTED8, AlgorithmMorphology2D.CONNECTED12, AlgorithmMorphology2D.SIZED_CIRCLE, AlgorithmMorphology3D.CONNECTED6, AlgorithmMorphology3D.CONNECTED26, AlgorithmMorphology3D.CONNECTED24, AlgorithmMorphology3D.SIZED_SPHERE (or the AlgorithmMorphology25D ones))

    • buildComboBox

      private void buildComboBox()
      Builds kernel combo box.

    • 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

    • 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.