Package gov.nih.mipav.view.dialogs

Class JDialogAutoCorrelation

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.JDialogAutoCorrelation
All Implemented Interfaces:
AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants
public class JDialogAutoCorrelation extends JDialogScriptableBase implements AlgorithmInterface, ActionDiscovery, ScriptableActionInterface
Dialog to call AlgorithmAutoCorrelation.
See Also:

  • Field Details

    • serialVersionUID

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

    • algoAutoCorrelation

      private AlgorithmAutoCorrelation algoAutoCorrelation
      DOCUMENT ME!

    • haveBlue

      private boolean haveBlue
      DOCUMENT ME!

    • haveGreen

      private boolean haveGreen
      DOCUMENT ME!

    • haveRed

      private boolean haveRed
      DOCUMENT ME!

    • image

      private ModelImage image
      DOCUMENT ME!

    • maxR

      private double maxR
      DOCUMENT ME!

    • maxG

      private double maxG
      DOCUMENT ME!

    • maxB

      private double maxB
      DOCUMENT ME!

    • minR

      private double minR
      DOCUMENT ME!

    • minG

      private double minG
      DOCUMENT ME!

    • minB

      private double minB
      DOCUMENT ME!

    • resultImage

      private ModelImage resultImage
      DOCUMENT ME!

    • resultImageB

      private ModelImage resultImageB
      DOCUMENT ME!

    • resultImageG

      private ModelImage resultImageG
      DOCUMENT ME!

    • resultImageR

      private ModelImage resultImageR
      DOCUMENT ME!

    • titles

      private String[] titles
      DOCUMENT ME!

    • UI

      private ViewUserInterface UI
      DOCUMENT ME!

  • Constructor Details

    • JDialogAutoCorrelation

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

    • JDialogAutoCorrelation

      public JDialogAutoCorrelation(Frame theParentFrame, ModelImage im)
      Constructs new transform dialog and sets up GUI components.
      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 the variables, 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

    • getResultImageB

      public ModelImage getResultImageB()
      Accessor that returns the blue image.
      Returns:
      The result blue image

    • getResultImageG

      public ModelImage getResultImageG()
      Accessor that returns the green image.
      Returns:
      The result green image

    • getResultImageR

      public ModelImage getResultImageR()
      Accessor that returns the red image.
      Returns:
      The result red image

    • callAlgorithm

      protected void callAlgorithm()
      Calls the algorithm with the set variables.
      Specified by:
      callAlgorithm in class JDialogScriptableBase

    • doPostAlgorithmActions

      protected void doPostAlgorithmActions()
      Register the result image(s) in the script runner.
      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 dialog box to a certain size and adds the components.

    • setVariables

      private boolean setVariables()
      Sets the variables needed to run the algorithm.
      Returns:
      Flag indicating successful set of the variables.

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