Package gov.nih.mipav.view.dialogs

Class JDialogAHE

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.JDialogAHE
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogAHE extends JDialogScriptableBase implements AlgorithmInterface, ActionDiscovery, ScriptableActionInterface
Adaptive Histogram Equlization.

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 should be noted, that the algorithms are executed in their own thread.

Version:
1.0; 17 February 2000
Author:
parsonsd, Matthew J. McAuliffe, Ph.D.
See Also:

  • Field Details

    • serialVersionUID

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

    • aheAlgo

      private AlgorithmAHE aheAlgo
      DOCUMENT ME!

    • clamp

      private boolean clamp
      DOCUMENT ME!

    • clampImage

      private JCheckBox clampImage
      DOCUMENT ME!

    • clampingValue

      private JTextField clampingValue
      DOCUMENT ME!

    • clampValue

      private int clampValue
      DOCUMENT ME!

    • clampValueLabel

      private JLabel clampValueLabel
      DOCUMENT ME!

    • comboBoxHeightDiv

      private JComboBox comboBoxHeightDiv
      DOCUMENT ME!

    • comboBoxWidthDiv

      private JComboBox comboBoxWidthDiv
      DOCUMENT ME!

    • destinationGroup

      private ButtonGroup destinationGroup
      or if the source image is to be replaced.

    • displayLoc

      private int displayLoc
      DOCUMENT ME!

    • heightDivisions

      private int heightDivisions
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • newImage

      private JRadioButton newImage
      DOCUMENT ME!

    • replaceImage

      private JRadioButton replaceImage
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

    • widthDivisions

      private int widthDivisions
      DOCUMENT ME!

    • useCIELab

      private boolean useCIELab

    • colorGroup

      private ButtonGroup colorGroup

    • CIELabButton

      private JRadioButton CIELabButton

    • RGBButton

      private JRadioButton RGBButton

    • redBox

      private JCheckBox redBox

    • greenBox

      private JCheckBox greenBox

    • blueBox

      private JCheckBox blueBox

    • useRed

      private boolean useRed

    • useGreen

      private boolean useGreen

    • useBlue

      private boolean useBlue

  • Constructor Details

    • JDialogAHE

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

    • JDialogAHE

      public JDialogAHE(Frame theParentFrame, ModelImage im)
      Creates a new JDialogAHE 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 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.

    • setClampFlag

      public void setClampFlag(boolean flag)
      Accessor that sets the clamp flag.
      Parameters:
      flag - true indicates clamp, false otherwise.

    • setClampingValue

      public void setClampingValue(int value)
      Accessor that sets the clamping value.
      Parameters:
      value - Value to set clamping to.

    • setDisplayLocNew

      public void setDisplayLocNew()
      Accessor that sets the display loc variable to new, so that a new image is created once the algorithm completes.

    • setDisplayLocReplace

      public void setDisplayLocReplace()
      Accessor that sets the display loc variable to replace, so the current image is replaced once the algorithm completes.

    • setHeightDivisions

      public void setHeightDivisions(int value)
      Accessor that sets the height divisions.
      Parameters:
      value - Value to set height divisions to.

    • setWidthDivisions

      public void setWidthDivisions(int value)
      Accessor that sets the width divisions.
      Parameters:
      value - Value to set width divisions to.

    • callAlgorithm

      protected void callAlgorithm()
      Once all the necessary variables are set, call the 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()
      Store the result image in the script runner's image table now that the action execution is finished.
      Overrides:
      doPostAlgorithmActions in class JDialogScriptableBase

    • makeNumericsOnly

      protected void makeNumericsOnly(JTextField txt)
      Takes a text field, and forces the textfield to accept numbers, backspace and delete-key entries.
      Parameters:
      txt - Text field to modify.

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

    • buildDivisionComboBoxes

      private void buildDivisionComboBoxes()
      Creates the combo-box that allows user to select the number of divisions in the image when building the histogram.

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