Package gov.nih.mipav.view.dialogs

Class JDialogNLMeans_filt2D

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.JDialogNLMeans_filt2D
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogNLMeans_filt2D extends JDialogScriptableBase implements AlgorithmInterface, ItemListener, ActionDiscovery, ScriptableActionInterface
Dialog to get user input, then call the algorithm. The user has the option to generate a new image or replace the source image. It should be noted that the algorithms are executed in their own threads.
Version:
September 3, 2021
See Also:

  • Field Details

    • destinationGroup

      private ButtonGroup destinationGroup
      DOCUMENT ME!

    • destinationPanel

      private JPanel destinationPanel
      DOCUMENT ME!

    • displayLoc

      private int displayLoc
      DOCUMENT ME!

    • filterPanel

      private JPanel filterPanel
      DOCUMENT ME!

    • sigmaX

      private double sigmaX
      DOCUMENT ME!

    • NLMeansAlgo

      private NLMeans_filt2D NLMeansAlgo
      DOCUMENT ME!

    • sigmaY

      private double sigmaY
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • labelSigmaX

      private JLabel labelSigmaX
      DOCUMENT ME!

    • labelSigmaY

      private JLabel labelSigmaY
      DOCUMENT ME!

    • labelKSize

      private JLabel labelKSize
      DOCUMENT ME!

    • labelSSize

      private JLabel labelSSize
      DOCUMENT ME!

    • labelNoise

      private JLabel labelNoise
      DOCUMENT ME!

    • mainPanel

      private JPanel mainPanel
      DOCUMENT ME!

    • newImage

      private JRadioButton newImage
      DOCUMENT ME!

    • replaceImage

      private JRadioButton replaceImage
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • ksize

      private int ksize
      Neighbor window size

    • ssize

      private int ssize
      DOCUMENT ME!

    • textSigmaX

      private JTextField textSigmaX
      DOCUMENT ME!

    • textSigmaY

      private JTextField textSigmaY
      DOCUMENT ME!

    • textKSize

      private JTextField textKSize
      DOCUMENT ME!

    • textSSize

      private JTextField textSSize
      DOCUMENT ME!

    • textNoise

      private JTextField textNoise
      DOCUMENT ME!

    • noise_std

      private double noise_std
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

  • Constructor Details

    • JDialogNLMeans_filt2D

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

    • JDialogNLMeans_filt2D

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

    • 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()
      Store the result image in the script runner's image table now that the action execution is finished.
      Overrides:
      doPostAlgorithmActions in class JDialogScriptableBase

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

    • setSigmaX

      public void setSigmaX(double sigmaX)
      Accessor that sets X dimension Gaussian scale.
      Parameters:
      sigmaX - Value to set X dimension Gaussian scale to.

    • setSigmaY

      public void setSigmaY(double sigmaY)
      Accessor that sets Y dimension Gaussian scale.
      Parameters:
      sigmaY - Value to set Y dimension Gaussian scale to.

    • setKSize

      public void setKSize(int ksize)
      Accessor that sets the Neighbor window size.
      Parameters:
      ksize - Value to set neighbor window size to.

    • setSSize

      public void setSSize(int ssize)
      Accessor that sets the search window size.
      Parameters:
      ssize - Value to set search window size to.

    • setNoise_std

      public void setNoise_std(double noise_std)
      Accessor that sets the noise standard deviation.
      Parameters:
      noise_std - Value to set noise standard deviation to.

    • callAlgorithm

      protected void callAlgorithm()
      Once all the necessary variables are set, call the Frequency Filter 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

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