Package gov.nih.mipav.view.dialogs
Class MTryJistHook
java.lang.Object
gov.nih.mipav.view.dialogs.MTryJistHook
- All Implemented Interfaces:
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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in).invalid reference
#setGUIFromParams()Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).Return meta-information about this discoverable action for categorization and labeling purposes.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).booleanReturns whether the action has successfully completed its execution.voidscriptRun(ParameterTable table) Starts execution of the action.
-
Field Details
-
internalDialog
private mtry.PlugInDialogMTry534d internalDialog
-
-
Constructor Details
-
MTryJistHook
public MTryJistHook()
-
-
Method Details
-
getActionMetadata
Description copied from interface:ActionDiscoveryReturn meta-information about this discoverable action for categorization and labeling purposes.- Specified by:
getActionMetadatain interfaceActionDiscovery- Returns:
- Metadata for this action.
-
createInputParameters
Description copied from interface:ActionDiscoveryReturns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in).invalid reference
#setGUIFromParams()- Specified by:
createInputParametersin interfaceActionDiscovery- Returns:
- A parameter table listing the inputs of this algorithm.
-
createOutputParameters
Description copied from interface:ActionDiscoveryReturns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).- Specified by:
createOutputParametersin interfaceActionDiscovery- Returns:
- A parameter table listing the outputs of this algorithm.
-
scriptRun
Description copied from interface:ActionDiscoveryStarts execution of the action. Should be the same as the scriptRun() method used by the MIPAV scripting system.- Specified by:
scriptRunin interfaceActionDiscovery- Parameters:
table- The input parameters (with values set) to be used to run the action.
-
getOutputImageName
Description copied from interface:ActionDiscoveryReturns 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:
getOutputImageNamein interfaceActionDiscovery- 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:ActionDiscoveryReturns whether the action has successfully completed its execution.- Specified by:
isActionCompletein interfaceActionDiscovery- Returns:
- True, if the action is complete. False, if the action failed or is still running.
-