ActionSaveImage (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.ActionSaveBase
    - - gov.nih.mipav.model.scripting.actions.ActionSaveImage

All Implemented Interfaces:

ScriptableActionInterface
```
public class ActionSaveImage
extends ActionSaveBase
```
A script action which writes out an image to disk.

Field Summary
- Fields inherited from class gov.nih.mipav.model.scripting.actions.ActionSaveBase
  AVI_COMPRESSION, END_SLICE, END_TIME, NIFTI_EXTENSION, recordingOptions, SAVE_FILE_NAME, SAVE_FILE_TYPE, SAVE_PREFIX, SAVE_SUFFIX, START_SLICE, START_TIME, TIFF_DIGIT_NUMBER, TIFF_SET_WRITE_PACK_BIT, TIFF_START_NUMBER, TIME_SLICE
- 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
`ActionSaveImage()`	Constructor for the dynamic instantiation and execution of the SaveImage script action.
`ActionSaveImage(ModelImage input, FileWriteOptions options)`	Constructor used to record the script action line.

Method Summary

All Methods Instance Methods Concrete Methods
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.ActionSaveBase
addSaveOptionsToParameters, getSaveImageOptions, setSaveOptions

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 Detail
  - ActionSaveImage
```
public ActionSaveImage()
```
    Constructor for the dynamic instantiation and execution of the SaveImage script action.
  - ActionSaveImage
```
public ActionSaveImage(ModelImage input,
                       FileWriteOptions options)
```
    Constructor used to record the script action line.
    
    Parameters:
    
    input - The image which was saved.
    
    options - The options used during the image save.
- 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:
    
    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.