Package gov.nih.mipav.view.dialogs

Class JDialogPadImages

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.JDialogPadImages
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogPadImages extends JDialogScriptableBase implements AlgorithmInterface, ScriptableActionInterface, ActionDiscovery
Creates the dialog to pad blank images to an active image. Dialog asks the user how to pad the blank images, such as padding to the front or back of the image, half to front and half to back of the image. It gives options to remove or to cancel.
Author:
Ruida Cheng
See Also:

  • Field Details

    • serialVersionUID

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

    • PAD_FRONT

      public static final int PAD_FRONT
      Pad the image by adding blank slices to the front:
      See Also:

    • PAD_BACK

      public static final int PAD_BACK
      Pad the image by adding blank slices to the back:
      See Also:

    • PAD_HALF

      public static final int PAD_HALF
      Pad the image by adding blank slices to the front and back:
      See Also:

    • displayLoc

      private int displayLoc
      Flag indicating if a new image is to be generated or if the source image is to be replaced

    • image

      private ModelImage image
      source image

    • newImage

      private JRadioButton newImage
      generate new image

    • nSlices

      private int nSlices
      number of slices in image

    • paddedSlices

      private int paddedSlices
      number of slices in padded image

    • padMode

      private int padMode
      Padding mode, defaults to front.

    • padSlicesAlgo

      private AlgorithmAddMargins padSlicesAlgo
      Algorithm that adds slices to front/back of image.

    • padToBack

      private JRadioButton padToBack
      Select padding to the back:

    • padToFront

      private JRadioButton padToFront
      Select padding to the front:

    • padToHalf

      private JRadioButton padToHalf
      Select padding to the front and back:

    • replaceImage

      private JRadioButton replaceImage
      Select replacing the current image

    • resultImage

      private ModelImage resultImage
      result image

    • userInterface

      private ViewUserInterface userInterface
      Reference to the main user interface

  • Constructor Details

    • JDialogPadImages

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

    • JDialogPadImages

      public JDialogPadImages(Frame theParentFrame, ModelImage im)
      Creates new dialog for removing slices.
      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

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

    • setPadMode

      public void setPadMode(int padMode)
      Accessor to set padMode.
      Parameters:
      padMode - int

    • callAlgorithm

      protected void callAlgorithm()
      Once all the necessary variables are set, call the Remove Slices 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()
      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()
      Description copied from interface: ActionDiscovery
      Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in
      invalid reference 
      #setGUIFromParams()
      ).
      Specified by:
      createInputParameters in interface ActionDiscovery
      Returns:
      A parameter table listing the inputs of this algorithm.

    • createOutputParameters

      public ParameterTable createOutputParameters()
      Description copied from interface: ActionDiscovery
      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)
      Description copied from interface: ActionDiscovery
      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()
      Description copied from interface: ActionDiscovery
      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.