Class JDialogMean

  • All Implemented Interfaces:
    AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.event.ItemListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.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:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog
      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer
      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
    • Constructor Summary

      Constructors 
      Constructor Description
      JDialogMean()
      Empty constructor needed for dynamic instantiation (used during scripting).
      JDialogMean​(java.awt.Frame theParentFrame, ModelImage im)
      Creates a new JDialogMean object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionPerformed​(java.awt.event.ActionEvent event)
      Closes dialog box when the OK button is pressed and calls the algorithm.
      void algorithmPerformed​(AlgorithmBase algorithm)
      This method is required if the AlgorithmPerformed interface is implemented.
      private void buildKernelSizeComboBox​(boolean singleSlices)
      Creates the combo-box that allows user to select the size of the kernel (mask).
      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.
      ParameterTable createInputParameters()
      Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in setGUIFromParams()).
      ParameterTable createOutputParameters()
      Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).
      private void determineKernelSize()
      Associate one side of the kernel size with selectBox choice.
      protected void doPostAlgorithmActions()
      Store the result image in the script runner's image table now that the action execution is finished.
      ActionMetadata getActionMetadata()
      Return meta-information about this discoverable action for categorization and labeling purposes.
      java.lang.String getOutputImageName​(java.lang.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).
      ModelImage getResultImage()
      Accessor that returns the image.
      private void init()
      Sets up the GUI (panels, buttons, etc) and displays it on the screen.
      boolean isActionComplete()
      Returns whether the action has successfully completed its execution.
      void setBlue​(boolean flag)
      Accessor that sets the color flag.
      void setBlueVector​(int blueVector)
      DOCUMENT ME!
      void setFilterType​(int filterType)
      DOCUMENT ME!
      void setGreen​(boolean flag)
      Accessor that sets the color flag.
      void setGreenVector​(int greenVector)
      DOCUMENT ME!
      protected void setGUIFromParams()
      Set the dialog GUI using the script parameters while running this algorithm as part of a script.
      void setImage25D​(boolean flag)
      Accessor that sets the slicing flag.
      void setKernelSize​(int size)
      Accessor that sets the kernel size.
      void setRed​(boolean flag)
      Accessor that sets the color flag.
      void setRedVector​(int redVector)
      DOCUMENT ME!
      private boolean setVariables()
      Use the GUI results to set up the variables needed to run the algorithm.
      protected void storeParamsFromGUI()
      Record the parameters just used to run this algorithm in a script.
      • Methods inherited from class javax.swing.JDialog

        addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
      • Methods inherited from class java.awt.Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Use serialVersionUID for interoperability.
        See Also:
        Constant Field Values
      • SEPARATE_COMPONENT

        public static final int SEPARATE_COMPONENT
        DOCUMENT ME!
        See Also:
        Constant Field Values
      • adaptiveVectorButton

        private javax.swing.JRadioButton adaptiveVectorButton
        DOCUMENT ME!
      • blue

        private boolean blue
        DOCUMENT ME!
      • blueChannel

        private javax.swing.JCheckBox blueChannel
        DOCUMENT ME!
      • blueLabel

        private javax.swing.JLabel blueLabel
        DOCUMENT ME!
      • blueText

        private javax.swing.JTextField blueText
        DOCUMENT ME!
      • blueVector

        private int blueVector
        DOCUMENT ME!
      • bySlice

        private javax.swing.JRadioButton bySlice
        DOCUMENT ME!
      • comboBoxKernelSize

        private javax.swing.JComboBox comboBoxKernelSize
        DOCUMENT ME!
      • filterType

        private int filterType
        DOCUMENT ME!
      • green

        private boolean green
        DOCUMENT ME!
      • greenChannel

        private javax.swing.JCheckBox greenChannel
        DOCUMENT ME!
      • greenLabel

        private javax.swing.JLabel greenLabel
        DOCUMENT ME!
      • greenText

        private javax.swing.JTextField greenText
        DOCUMENT ME!
      • greenVector

        private int greenVector
        DOCUMENT ME!
      • image25D

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

        private int kernelSize
        DOCUMENT ME!
      • parallelVectorButton

        private javax.swing.JRadioButton parallelVectorButton
        DOCUMENT ME!
      • red

        private boolean red
        DOCUMENT ME!
      • redChannel

        private javax.swing.JCheckBox redChannel
        DOCUMENT ME!
      • redLabel

        private javax.swing.JLabel redLabel
        DOCUMENT ME!
      • redText

        private javax.swing.JTextField redText
        DOCUMENT ME!
      • redVector

        private int redVector
        DOCUMENT ME!
      • resultImage

        private ModelImage resultImage
        DOCUMENT ME!
      • separateButton

        private javax.swing.JRadioButton separateButton
        DOCUMENT ME!
      • separateVectorGroup

        private javax.swing.ButtonGroup separateVectorGroup
        DOCUMENT ME!
      • titles

        private java.lang.String[] titles
        DOCUMENT ME!
      • wholeVolume

        private javax.swing.JRadioButton wholeVolume
        DOCUMENT ME!
    • Constructor Detail

      • JDialogMean

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

        public JDialogMean​(java.awt.Frame theParentFrame,
                           ModelImage im)
        Creates a new JDialogMean object.
        Parameters:
        theParentFrame - Parent frame.
        im - Source image.
    • Method Detail

      • actionPerformed

        public void actionPerformed​(java.awt.event.ActionEvent event)
        Closes dialog box when the OK button is pressed and calls the algorithm.
        Specified by:
        actionPerformed in interface java.awt.event.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​(int 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​(int 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​(int 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
      • 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 java.lang.String getOutputImageName​(java.lang.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.