Package gov.nih.mipav.view.dialogs

Class JDialogNonlocalMeansFilter

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.JDialogNonlocalMeansFilter
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogNonlocalMeansFilter extends JDialogScriptableBase implements AlgorithmInterface, ScriptableActionInterface, 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. Algorithms are executed in their own thread.
See Also:

  • Field Details

    • nlMeansFilterAlgo

      private AlgorithmNonlocalMeansFilter nlMeansFilterAlgo
      DOCUMENT ME!

    • destinationGroup

      private ButtonGroup destinationGroup
      DOCUMENT ME!

    • destinationPanel

      private JPanel destinationPanel
      DOCUMENT ME!

    • displayLoc

      private int displayLoc
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • image25D

      private boolean image25D
      DOCUMENT ME!

    • image25DCheckBox

      private JCheckBox image25DCheckBox
      DOCUMENT ME!

    • labelSimilarityWindowSide

      private JLabel labelSimilarityWindowSide
      DOCUMENT ME!

    • labelNoiseStandardDeviation

      private JLabel labelNoiseStandardDeviation
      DOCUMENT ME!

    • labelSearchWindowSide

      private JLabel labelSearchWindowSide
      DOCUMENT ME!

    • newImage

      private JRadioButton newImage
      DOCUMENT ME!

    • paramPanel

      private JPanel paramPanel
      DOCUMENT ME!

    • similarityWindowSide

      private int similarityWindowSide
      DOCUMENT ME!

    • noiseStandardDeviation

      private float noiseStandardDeviation
      Should be set equal to the noise standard deviation

    • searchWindowSide

      private int searchWindowSide
      DOCUMENT ME!

    • replaceImage

      private JRadioButton replaceImage
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • textSimilarityWindowSide

      private JTextField textSimilarityWindowSide
      DOCUMENT ME!

    • textNoiseStandardDeviation

      private JTextField textNoiseStandardDeviation
      DOCUMENT ME!

    • textSearchWindowSide

      private JTextField textSearchWindowSide
      DOCUMENT ME!

    • labelDegree

      private JLabel labelDegree

    • textDegree

      private JTextField textDegree

    • degreeOfFiltering

      private float degreeOfFiltering

    • doRicianCheckBox

      private JCheckBox doRicianCheckBox

    • doRician

      private boolean doRician

    • estimateNoiseCheckBox

      private JCheckBox estimateNoiseCheckBox

    • estimateNoiseStandardDeviation

      private boolean estimateNoiseStandardDeviation

    • titles

      private String[] titles
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

    • BayesCheckBox

      private JCheckBox BayesCheckBox

    • doBayesShrinkThresholdComputation

      private boolean doBayesShrinkThresholdComputation

  • Constructor Details

    • JDialogNonlocalMeansFilter

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

    • JDialogNonlocalMeansFilter

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

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

    • setImage25D

      public void setImage25D(boolean image25D)
      Accessor that sets whether 3D images are 3D or 2.5D filtered.
      Parameters:
      image25D - true for 2.5D filtering

    • setSimilarityWindowSide

      public void setSimilarityWindowSide(int similarityWindowSide)
      Accessor that sets the similarity window side.
      Parameters:
      similarityWindowSide - Value to set similarity window side to.

    • setNoiseStandardDeviation

      public void setNoiseStandardDeviation(int noiseStandardDeviation)
      Accessor that sets the noise standard deviation.
      Parameters:
      noiseStandardDeviation - Value to set noiseStandardDeviation to.

    • setSearchWindowSide

      public void setSearchWindowSide(int searchWindowSide)
      Accessor that sets the search window side.
      Parameters:
      searchWindowSide - Value to set search window side to.

    • setDegreeOfFiltering

      public void setDegreeOfFiltering(float degreeOfFiltering)
      Accessor that sets degree of filtering
      Parameters:
      degreeOfFiltering -

    • setDoRician

      public void setDoRician(boolean doRician)
      Accessor that sets doRician
      Parameters:
      doRician -

    • callAlgorithm

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

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