Class MTryJistHook

java.lang.Object
gov.nih.mipav.view.dialogs.MTryJistHook
All Implemented Interfaces:
ActionDiscovery

public class MTryJistHook extends Object implements ActionDiscovery
This class is an example class for tying existing plugins into the JIST interface. This class can be inserted into any build of MIPAV which has a compatible build of JIST. JIST will then discover the plugin and execute it appropriately.
Author:
senseneyj
  • Field Details

    • internalDialog

      private mtry.PlugInDialogMTry534d internalDialog
  • Constructor Details

    • MTryJistHook

      public MTryJistHook()
  • Method Details

    • getActionMetadata

      public ActionMetadata getActionMetadata()
      Description copied from interface: ActionDiscovery
      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.
    • scriptRun

      public void scriptRun(ParameterTable table)
      Description copied from interface: ActionDiscovery
      Starts execution of the action. Should be the same as the scriptRun() method used by the MIPAV scripting system.
      Specified by:
      scriptRun in interface ActionDiscovery
      Parameters:
      table - The input parameters (with values set) to be used to run the action.
    • 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.