Package gov.nih.mipav.view.dialogs

Class JDialogCyclicPermutation

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.JDialogCyclicPermutation
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogCyclicPermutation extends JDialogScriptableBase implements AlgorithmInterface, ScriptableActionInterface, ActionDiscovery
Creates the dialog to cyclically permute pixels around the image.

User selects:

  1. shiftX
  2. shiftY
  3. shiftZ for 3D and 4D
  4. shiftT for 4D

A new image or replacement of the old image may be selected.

See Also:

  • Field Details

    • shiftTInput

      private JTextField shiftTInput
      DOCUMENT ME!

    • shiftT

      private int shiftT
      DOCUMENT ME!

    • cpAlgo

      private AlgorithmCyclicPermutation cpAlgo
      DOCUMENT ME!

    • destinationGroup

      private ButtonGroup destinationGroup
      DOCUMENT ME!

    • displayLoc

      private int displayLoc
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • shiftX

      private int shiftX
      DOCUMENT ME!

    • shiftXInput

      private JTextField shiftXInput
      DOCUMENT ME!

    • newImage

      private JRadioButton newImage
      DOCUMENT ME!

    • replaceImage

      private JRadioButton replaceImage
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • shiftY

      private int shiftY
      DOCUMENT ME!

    • shiftYInput

      private JTextField shiftYInput
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • shiftZInput

      private JTextField shiftZInput
      DOCUMENT ME!

    • shiftZ

      private int shiftZ
      DOCUMENT ME!

    • userInterface

      private ViewUserInterface userInterface
      DOCUMENT ME!

  • Constructor Details

    • JDialogCyclicPermutation

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

    • JDialogCyclicPermutation

      public JDialogCyclicPermutation(Frame theParentFrame, ModelImage im)
      Constructor that makes dialog and displays it.
      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 after adding image margins.
      Returns:
      The result image.

    • setShiftT

      public void setShiftT(int x)
      Accessor that sets the shiftT value.
      Parameters:
      x - Value to set shiftT value to.

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

    • setShiftX

      public void setShiftX(int x)
      Accessor that sets the shiftX value.
      Parameters:
      x - Value to set shiftX value to.

    • setShiftY

      public void setShiftY(int x)
      Accessor that sets the shiftY value.
      Parameters:
      x - Value to set shiftY value to.

    • setShiftZ

      public void setShiftZ(int x)
      Accessor that sets the shiftZ value.
      Parameters:
      x - Value to set shiftZ value to.

    • callAlgorithm

      protected void callAlgorithm()
      DOCUMENT ME!
      Specified by:
      callAlgorithm in class JDialogScriptableBase

    • determineNull

      protected JTextField determineNull()
      When one of the text inputs has been left blank, trying to convert them to ints results in throwing a null pointer exception. This method determines which one of the JTextFields threw the null pointer Exception.
      Returns:
      The text field that returned null.

    • 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 components and places them in the dialog.

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