Package gov.nih.mipav.view.dialogs

Class JDialogGradientMagnitude

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.JDialogGradientMagnitude
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogGradientMagnitude extends JDialogScriptableBase implements AlgorithmInterface, ActionDiscovery, ScriptableActionInterface
Dialog to get user input, then call the algorithm. The user is able to control the degree of blurring in all dimensions and indicate if a correction factor be applied to the z-dimension to account for differing resolutions between the xy resolutions (intra-plane) and the z resolution (inter-plane). The user has the option to generate a new image or replace the source image. In addition the user can indicate if you wishes to have the algorithm applied to whole image or to the VOI regions. In should be noted, that the algorithms are executed in their own thread.
Version:
0.1 Nov 17, 1998
Author:
Matthew J. McAuliffe, Ph.D.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Use serialVersionUID for interoperability.
      See Also:

    • colorChannelPanel

      private JPanelColorChannels colorChannelPanel
      DOCUMENT ME!

    • gradientMagAlgo

      private AlgorithmGradientMagnitude gradientMagAlgo
      DOCUMENT ME!

    • gradientMagSepAlgo

      private AlgorithmGradientMagnitudeSep gradientMagSepAlgo
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • image25D

      private boolean image25D
      DOCUMENT ME!

    • image25DCheckbox

      private JCheckBox image25DCheckbox
      DOCUMENT ME!

    • useOCLCheckbox

      private JCheckBox useOCLCheckbox
      Indicates whether user wants openCL for processing.

    • useOCL

      private boolean useOCL
      Flag indicating whether to use OpenCL processing.

    • outputOptionsPanel

      private JPanelAlgorithmOutputOptions outputOptionsPanel
      DOCUMENT ME!

    • outputImageType

      private int outputImageType

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • separable

      private boolean separable
      DOCUMENT ME!

    • sepCheckbox

      private JCheckBox sepCheckbox
      DOCUMENT ME!

    • sigmaPanel

      private JPanelSigmas sigmaPanel
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

    • displayProgressBar

      private boolean displayProgressBar
      display progress bar or not.

  • Constructor Details

    • JDialogGradientMagnitude

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

    • JDialogGradientMagnitude

      public JDialogGradientMagnitude(Frame theParentFrame, ModelImage im)
      Construct the gradient magnitude dialog.
      Parameters:
      theParentFrame - Parent frame.
      im - Source image.

  • Method Details

    • actionPerformed

      public void actionPerformed(ActionEvent event)
      Closes dialog box when the OK button is pressed, sets variables and calls 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)
      Resets labels if checkboxes are checked or unchecked.
      Specified by:
      itemStateChanged in interface ItemListener
      Overrides:
      itemStateChanged in class JDialogBase
      Parameters:
      event - Event that cause the method to fire.

    • setImage25D

      public void setImage25D(boolean flag)
      Accessor that sets the slicing flag.
      Parameters:
      flag - true indicates slices should be blurred independently.

    • setSeparable

      public void setSeparable(boolean separable)
      Accessor that sets whether or not the separable convolution kernel is used.
      Parameters:
      separable - DOCUMENT ME!

    • setUseOCL

      public void setUseOCL(boolean useOCL)
      Accessor that sets whether to use OpenCL processing (may still not be set if it is not supported on the system).
      Parameters:
      useOCL - Whether to try to use OpenCL processing.

    • setOutputNewImage

      public void setOutputNewImage(boolean flag)
      Changes whether a new image should be generated by the algorithm.
      Parameters:
      flag - true if a new image should be made, false otherwise

    • setOutputNewImageType

      public void setOutputNewImageType(int type)

    • setDisplayProgressBar

      public void setDisplayProgressBar(boolean flag)
      Set the display progress bar flag.
      Parameters:
      flag - display or not

    • callAlgorithm

      protected void callAlgorithm()
      Once all the necessary variables are set, call the Gradient Magnitude algorithm based on what type of image this is and whether or not there is a separate destination image.
      Specified by:
      callAlgorithm in class JDialogScriptableBase

    • doPostAlgorithmActions

      protected void doPostAlgorithmActions()
      Perform any actions required after the running of the algorithm is complete.
      Overrides:
      doPostAlgorithmActions in class JDialogScriptableBase

    • setGUIFromParams

      protected void setGUIFromParams()
      Set up the dialog GUI based on the parameters before running the algorithm as part of a script.
      Specified by:
      setGUIFromParams in class JDialogScriptableBase

    • storeParamsFromGUI

      protected void storeParamsFromGUI() throws ParserException
      Store the parameters from the dialog to record the execution of this algorithm.
      Specified by:
      storeParamsFromGUI in class JDialogScriptableBase
      Throws:
      ParserException - If there is a problem creating one of the new parameters.

    • init

      private void init()
      Initializes the GUI by creating the components, placing them in the dialog, and displaying them.

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