Class ActionSaveAllVOIs
- java.lang.Object
-
- gov.nih.mipav.model.scripting.actions.ActionBase
-
- gov.nih.mipav.model.scripting.actions.ActionImageProcessorBase
-
- gov.nih.mipav.model.scripting.actions.ActionSaveAllVOIs
-
- All Implemented Interfaces:
ScriptableActionInterface
public class ActionSaveAllVOIs extends ActionImageProcessorBase
A script action which saves all the VOIs in an image to disk.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.StringrecordingTargetDirThe directory where the VOIs were saved to, which should be recorded in the script.private static java.lang.StringSAVE_VOIS_TO_DIRThe label to use for the VOI-save destination directory parameter (leave empty for the default directory).-
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 ActionSaveAllVOIs()Constructor for the dynamic instantiation and execution of the SaveAllVOIs script action.ActionSaveAllVOIs(ModelImage input)Constructor used to record the SaveAllVOIs script action line.ActionSaveAllVOIs(ModelImage input, java.lang.String targetDir)Constructor used to record the SaveAllVOIs script action line.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidinsertScriptLine()If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.voidscriptRun(ParameterTable parameters)Sets up the action dialog state and then executes it.voidsetTargetDirectory(java.lang.String targetDir)Changes the target directory where the VOIs were saved, which should be recorded in the script.-
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
-
-
-
-
Field Detail
-
SAVE_VOIS_TO_DIR
private static final java.lang.String SAVE_VOIS_TO_DIR
The label to use for the VOI-save destination directory parameter (leave empty for the default directory).- See Also:
- Constant Field Values
-
recordingTargetDir
private java.lang.String recordingTargetDir
The directory where the VOIs were saved to, which should be recorded in the script. Leave empty or null to save in the current default directory.
-
-
Constructor Detail
-
ActionSaveAllVOIs
public ActionSaveAllVOIs()
Constructor for the dynamic instantiation and execution of the SaveAllVOIs script action.
-
ActionSaveAllVOIs
public ActionSaveAllVOIs(ModelImage input)
Constructor used to record the SaveAllVOIs script action line.- Parameters:
input- The image which had its VOIs saved.
-
ActionSaveAllVOIs
public ActionSaveAllVOIs(ModelImage input, java.lang.String targetDir)
Constructor used to record the SaveAllVOIs script action line.- Parameters:
input- The image which had its VOIs saved.targetDir- The directory where the VOIs were saved (leave empty or null for the default directory).
-
-
Method Detail
-
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:
insertScriptLinein interfaceScriptableActionInterface- Specified by:
insertScriptLinein classActionImageProcessorBase
-
scriptRun
public void scriptRun(ParameterTable parameters)
Sets up the action dialog state and then executes it.- Specified by:
scriptRunin interfaceScriptableActionInterface- Specified by:
scriptRunin classActionImageProcessorBase- Parameters:
parameters- Table of parameters for the script to use.
-
setTargetDirectory
public void setTargetDirectory(java.lang.String targetDir)
Changes the target directory where the VOIs were saved, which should be recorded in the script. Use empty or null string to indicate that the default directory should be used.- Parameters:
targetDir- The directory where the VOIs were saved.
-
-