ActionPaintToVOI (MIPAV API Documentation)

java.lang.Object

gov.nih.mipav.model.scripting.actions.ActionBase

gov.nih.mipav.model.scripting.actions.ActionImageProcessorBase

gov.nih.mipav.model.scripting.actions.ActionPaintToVOI

All Implemented Interfaces:: ScriptableActionInterface

public class ActionPaintToVOI extends ActionImageProcessorBase

A script action which generates a VOI based on the paint mask of an image.

Field Summary

Fields inherited from class gov.nih.mipav.model.scripting.actions.ActionImageProcessorBase
INPUT_IMAGE_LABEL, recordingInputImage, recordingResultImage

Fields inherited from class gov.nih.mipav.model.scripting.actions.ActionBase
isScript
Constructor Summary

Constructors

Constructor

Description

ActionPaintToVOI()

Constructor for the dynamic instantiation and execution of the PaintToVOI script action.

ActionPaintToVOI(ModelImage inputImage)

Constructor used to record the PaintToVOI script action line.
Method Summary

Modifier and Type

Method

Description

void

insertScriptLine()

If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.

void

scriptRun(ParameterTable parameters)

Sets up the action dialog state and then executes it.

Methods inherited from class gov.nih.mipav.model.scripting.actions.ActionImageProcessorBase
createInputImageParameter, isImageStoredInRecorder, setInputImage, setResultImage, storeImageInRecorder, storeImageInRunner

Methods inherited from class gov.nih.mipav.model.scripting.actions.ActionBase
getActionName, getActionName, isScript, setIsScript

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ActionPaintToVOI
  
  public ActionPaintToVOI()
  
  Constructor for the dynamic instantiation and execution of the PaintToVOI script action.
- ActionPaintToVOI
  
  public ActionPaintToVOI(ModelImage inputImage)
  
  Constructor used to record the PaintToVOI script action line.
  
  Parameters:
  
  inputImage - The image containg the paint mask which was used to generate the VOI.
Method Details
- insertScriptLine
  
  public void insertScriptLine()
  
  If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.
  
  Specified by:
  
  insertScriptLine in interface ScriptableActionInterface
  
  Specified by:
  
  insertScriptLine in class ActionImageProcessorBase
- scriptRun
  
  public void scriptRun(ParameterTable parameters)
  
  Sets up the action dialog state and then executes it.
  
  Specified by:
  
  scriptRun in interface ScriptableActionInterface
  
  Specified by:
  
  scriptRun in class ActionImageProcessorBase
  
  Parameters:
  
  parameters - Table of parameters for the script to use.