ActionChangeModality (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.ActionChangeModality

All Implemented Interfaces:

ScriptableActionInterface
```
public class ActionChangeModality
extends ActionImageProcessorBase
```
A script action which changes the image's modality

Field Summary

Fields
Modifier and Type Field Description

private static java.lang.String MODALITY
The label to use for the parameter indicating the new units
- 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
`ActionChangeModality()`	Constructor for the dynamic instantiation and execution of the script action.
`ActionChangeModality(ModelImage image)`	Main constructor with parameters for changing the modality

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.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

- Field Detail
  - MODALITY
```
private static final java.lang.String MODALITY
```
    The label to use for the parameter indicating the new units
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ActionChangeModality
```
public ActionChangeModality()
```
    Constructor for the dynamic instantiation and execution of the script action.
  - ActionChangeModality
```
public ActionChangeModality(ModelImage image)
```
    Main constructor with parameters for changing the modality
    
    Parameters:
    
    image - the input image
- 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.