Package gov.nih.mipav.view.dialogs

Class JDialogMean

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.JDialogMean
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogMean extends JDialogScriptableBase implements AlgorithmInterface, 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. In addition the user can select having the algorithm applied to whole image or to the VOI regions. It should be noted that the algorithms are executed in their own thread.
See Also:

  • Field Details

    • serialVersionUID

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

    • SEPARATE_COMPONENT

      public static final int SEPARATE_COMPONENT
      DOCUMENT ME!
      See Also:

    • ADAPTIVE_VECTOR

      public static final int ADAPTIVE_VECTOR
      DOCUMENT ME!
      See Also:

    • PARALLEL_VECTOR

      public static final int PARALLEL_VECTOR
      DOCUMENT ME!
      See Also:

    • adaptiveVectorButton

      private JRadioButton adaptiveVectorButton
      DOCUMENT ME!

    • blue

      private boolean blue
      DOCUMENT ME!

    • blueChannel

      private JCheckBox blueChannel
      DOCUMENT ME!

    • blueLabel

      private JLabel blueLabel
      DOCUMENT ME!

    • blueText

      private JTextField blueText
      DOCUMENT ME!

    • blueVector

      private long blueVector
      DOCUMENT ME!

    • bySlice

      private JRadioButton bySlice
      DOCUMENT ME!

    • comboBoxKernelSize

      private JComboBox comboBoxKernelSize
      DOCUMENT ME!

    • filterType

      private int filterType
      DOCUMENT ME!

    • green

      private boolean green
      DOCUMENT ME!

    • greenChannel

      private JCheckBox greenChannel
      DOCUMENT ME!

    • greenLabel

      private JLabel greenLabel
      DOCUMENT ME!

    • greenText

      private JTextField greenText
      DOCUMENT ME!

    • greenVector

      private long greenVector
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • image25D

      private boolean image25D
      false = apply algorithm only to VOI regions.

    • kernelSize

      private int kernelSize
      DOCUMENT ME!

    • meanAlgo

      private AlgorithmMean meanAlgo
      DOCUMENT ME!

    • outputPanel

      private JPanelAlgorithmOutputOptions outputPanel
      DOCUMENT ME!

    • parallelVectorButton

      private JRadioButton parallelVectorButton
      DOCUMENT ME!

    • red

      private boolean red
      DOCUMENT ME!

    • redChannel

      private JCheckBox redChannel
      DOCUMENT ME!

    • redLabel

      private JLabel redLabel
      DOCUMENT ME!

    • redText

      private JTextField redText
      DOCUMENT ME!

    • redVector

      private long redVector
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • separateButton

      private JRadioButton separateButton
      DOCUMENT ME!

    • separateVectorGroup

      private ButtonGroup separateVectorGroup
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

    • wholeVolume

      private JRadioButton wholeVolume
      DOCUMENT ME!

  • Constructor Details

    • JDialogMean

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

    • JDialogMean

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

    • setBlue

      public void setBlue(boolean flag)
      Accessor that sets the color flag.
      Parameters:
      flag - true indicates ARG image, blue.

    • setBlueVector

      public void setBlueVector(long blueVector)
      DOCUMENT ME!
      Parameters:
      blueVector - DOCUMENT ME!

    • setFilterType

      public void setFilterType(int filterType)
      DOCUMENT ME!
      Parameters:
      filterType - SEPARATE_COMPONENT, ADAPTIVE_VECTOR, or PARALLEL_VECTOR

    • setGreen

      public void setGreen(boolean flag)
      Accessor that sets the color flag.
      Parameters:
      flag - true indicates ARG image, green.

    • setGreenVector

      public void setGreenVector(long greenVector)
      DOCUMENT ME!
      Parameters:
      greenVector - DOCUMENT ME!

    • setImage25D

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

    • setKernelSize

      public void setKernelSize(int size)
      Accessor that sets the kernel size.
      Parameters:
      size - Value to set size to (3 == 3x3, 5 == 5x5, etc.)

    • setRed

      public void setRed(boolean flag)
      Accessor that sets the color flag.
      Parameters:
      flag - true indicates ARG image, red.

    • setRedVector

      public void setRedVector(long redVector)
      DOCUMENT ME!
      Parameters:
      redVector - DOCUMENT ME!

    • callAlgorithm

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

    • buildKernelSizeComboBox

      private void buildKernelSizeComboBox(boolean singleSlices)
      Creates the combo-box that allows user to select the size of the kernel (mask).
      Parameters:
      singleSlices - DOCUMENT ME!

    • determineKernelSize

      private void determineKernelSize()
      Associate one side of the kernel size with selectBox choice.

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