Interface ActionDiscovery

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ParameterTable createInputParameters()
      Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in #setGUIFromParams()).
      ParameterTable createOutputParameters()
      Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).
      ActionMetadata getActionMetadata()
      Return meta-information about this discoverable action for categorization and labeling purposes.
      java.lang.String getOutputImageName​(java.lang.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).
      boolean isActionComplete()
      Returns whether the action has successfully completed its execution.
      void scriptRun​(ParameterTable table)
      Starts execution of the action.
    • Method Detail

      • getActionMetadata

        ActionMetadata getActionMetadata()
        Return meta-information about this discoverable action for categorization and labeling purposes.
        Returns:
        Metadata for this action.
      • createInputParameters

        ParameterTable createInputParameters()
        Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in #setGUIFromParams()).
        Returns:
        A parameter table listing the inputs of this algorithm.
      • createOutputParameters

        ParameterTable createOutputParameters()
        Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).
        Returns:
        A parameter table listing the outputs of this algorithm.
      • scriptRun

        void scriptRun​(ParameterTable table)
        Starts execution of the action. Should be the same as the scriptRun() method used by the MIPAV scripting system.
        Parameters:
        table - The input parameters (with values set) to be used to run the action.
      • getOutputImageName

        java.lang.String getOutputImageName​(java.lang.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).
        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

        boolean isActionComplete()
        Returns whether the action has successfully completed its execution.
        Returns:
        True, if the action is complete. False, if the action failed or is still running.