ROIData (Mango Plugin API)

All Superinterfaces:

ColorManager
```
public interface ROIData
extends ColorManager
```
ROIData can be used to access and edit ROI mask, line, and point data.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BLUE_INDEX` Deprecated.
`static byte`	`BLUE_MASK` Deprecated.
`static int`	`CYAN_INDEX` Deprecated.
`static byte`	`CYAN_MASK` Deprecated.
`static int`	`GREEN_INDEX` Deprecated.
`static byte`	`GREEN_MASK` Deprecated.
`static int`	`INDEX_BLUE`
`static int`	`INDEX_GREEN`
`static int`	`INDEX_RED`
`static int`	`MAGENTA_INDEX` Deprecated.
`static byte`	`MAGENTA_MASK` Deprecated.
`static long`	`MASK_BLUE`
`static long`	`MASK_GREEN`
`static long`	`MASK_RED`
`static long`	`MASL_BLUE` Deprecated.
`static int`	`ORANGE_INDEX` Deprecated.
`static byte`	`ORANGE_MASK` Deprecated.
`static int`	`RED_INDEX` Deprecated.
`static byte`	`RED_MASK` Deprecated.
`static int`	`SLATE_INDEX` Deprecated.
`static byte`	`SLATE_MASK` Deprecated.
`static int`	`SLICE_DIRECTION_AXIAL`
`static int`	`SLICE_DIRECTION_CORONAL`
`static int`	`SLICE_DIRECTION_SAGITTAL`
`static int`	`YELLOW_INDEX` Deprecated.
`static byte`	`YELLOW_MASK` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, long mask)` Adds an ROI value at a specified location.
`void`	`addMaskValue(int xLoc, int yLoc, int zLoc, long mask)` Adds an ROI value at a specified location.
`void`	`addPoint(Coordinate point, int color)` Adds a point.
`void`	`addROIMaskValue(int xLoc, int yLoc, int zLoc, byte roiVal)` Deprecated.
`void`	`addROIMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, byte roiVal)` Deprecated.
`Shape`	`addShape(int sliceDirection, int slice, int color, Shape shape)` Add a shape of a specified color within a slice.
`void`	`addSpecialPoint(Coordinate point, Color color, boolean editable)` Adds a point with special properties that can only be removed programmatically.
`Shape`	`addSpecialShape(int sliceDirection, int slice, Color color, Shape shape, Stroke stroke, boolean editable, boolean fixed)` Add a shape with special properties that can only be remove programmatically.
`long`	`createMask(int colorIndex)` Creates a bit mask for a ROI color.
`List<ROI>`	`getAllROIs()` Returns a list of all ROIs.
`long`	`getAvailableMask()` If there exists selected mask, it returns getSelectedMask(), otherwise it returns getUsedMaks().
`LabelManager`	`getLabelManager()` Returns the ROI mask LabelManager.
`long`	`getMaskValue(int xLoc, int yLoc, int zLoc)` Gets the ROI value at a specified location.
`long`	`getMaskValue(int xLoc, int yLoc, int zLoc, int tLoc)` Gets the ROI value at a specified location.
`Coordinate[]`	`getPoints(int color)` Gets all points of a specified color.
`Color`	`getROIColor(int colorIndex)` Returns the color of this ROI.
`ROIMaskBuffer`	`getROIDataBuffer()` Returns the ROI data buffer.
`String`	`getROILabel(int colorIndex)` Returns the label of this ROI.
`ByteBuffer`	`getROIMaskBuffer()` Deprecated.
`byte`	`getROIMaskValue(int xLoc, int yLoc, int zLoc)` Deprecated.
`byte`	`getROIMaskValue(int xLoc, int yLoc, int zLoc, int tLoc)` Deprecated.
`byte`	`getROISelectedMask()` Deprecated.
`byte`	`getROIUsedMask()` Deprecated.
`List<Line>`	`getSelectedLines()` Returns a list of selected ROI lines.
`long`	`getSelectedMask()` Returns a bit mask of selected ROI colors.
`List<ROI>`	`getSelectedMasks()` Returns a list of selected ROI masks.
`List<Point>`	`getSelectedPoints()` Returns a list of selected ROI points.
`List<ROI>`	`getSelectedROIs()` Returns a list of selected ROIs.
`Shape[]`	`getShapes(int sliceDirection, int slice, int color)` Gets all shapes of a specified color within a slice.
`Coordinate[]`	`getSpecialPoints(Color color)` Gets all special points of a specified color.
`Shape[]`	`getSpecialShapes(int sliceDirection, int slice, Color color)` Gets all special shapes of a specified color within a slice.
`List<Line>`	`getUsedLines()` Returns a list of used ROI lines.
`long`	`getUsedMask()` Returns a bit mask of used ROI colors.
`List<ROI>`	`getUsedMasks()` Returns a list of used ROIs.
`List<Point>`	`getUsedPoints()` Returns a list of used ROI points.
`boolean`	`hasSelectedMaskInRange(int xMin, int xMax, int yMin, int yMax, int zMin, int zMax)` Test if there is a selected ROI mask in the specified bounds.
`void`	`initMask(long mask)` Initializes one or more ROI colors.
`void`	`initROIMask(byte mask)` Deprecated.
`boolean`	`isInsideSelectedMaskAtOffset(int offset)` Test if there is a selected ROI mask at the specified offset.
`void`	`removePoint(Coordinate point, int color)` Removes a point.
`void`	`removeShape(int sliceDirection, Shape shape)` Remove a shape.
`void`	`removeSpecialPoint(Coordinate point, Color color)` Removes a special point.
`void`	`removeSpecialShape(int sliceDirection, Shape shape)` Remove a special shape.
`void`	`replaceMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, long mask)` Replace a ROI value at a specified location.
`void`	`replaceMaskValue(int xLoc, int yLoc, int zLoc, long mask)` Replace a ROI value at a specified location.
`void`	`replaceROIMaskValue(int xLoc, int yLoc, int zLoc, byte roiVal)` Deprecated.
`void`	`replaceROIMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, byte roiVal)` Deprecated.
`void`	`roiMaskOperationCompleted()` Call this following an ROI operation (e.g., after iterating through the entire volume making changes).
`void`	`roiMaskOperationCompleted(String des)` Call this following an ROI operation (e.g., after iterating through the entire volume making changes).
`void`	`setPointHighlightState(Coordinate point, Color color, boolean highlight)` Sets the highlight state of a special point.
`void`	`setShapeHighlightState(int sliceDirection, Shape shape, boolean highlight)` Sets the highlight state of a special shape.
`void`	`setUseROISeries(boolean useROISeries)` True to use a ROI series, false otherwise.

Methods inherited from interface edu.uthscsa.ric.roi.ColorManager
getMaximumColors, isSelected, isUsed

- Field Detail
  - BLUE_MASK
```
@Deprecated
static final byte BLUE_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - CYAN_MASK
```
@Deprecated
static final byte CYAN_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - GREEN_MASK
```
@Deprecated
static final byte GREEN_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - MAGENTA_MASK
```
@Deprecated
static final byte MAGENTA_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - ORANGE_MASK
```
@Deprecated
static final byte ORANGE_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - RED_MASK
```
@Deprecated
static final byte RED_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - SLATE_MASK
```
@Deprecated
static final byte SLATE_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - YELLOW_MASK
```
@Deprecated
static final byte YELLOW_MASK
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - BLUE_INDEX
```
@Deprecated
static final int BLUE_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - CYAN_INDEX
```
@Deprecated
static final int CYAN_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - GREEN_INDEX
```
@Deprecated
static final int GREEN_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - MAGENTA_INDEX
```
@Deprecated
static final int MAGENTA_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - ORANGE_INDEX
```
@Deprecated
static final int ORANGE_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - RED_INDEX
```
@Deprecated
static final int RED_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - SLATE_INDEX
```
@Deprecated
static final int SLATE_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - YELLOW_INDEX
```
@Deprecated
static final int YELLOW_INDEX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - MASL_BLUE
```
@Deprecated
static final long MASL_BLUE
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - INDEX_BLUE
```
static final int INDEX_BLUE
```
    See Also:
    Constant Field Values
  - INDEX_GREEN
```
static final int INDEX_GREEN
```
    See Also:
    Constant Field Values
  - INDEX_RED
```
static final int INDEX_RED
```
    See Also:
    Constant Field Values
  - SLICE_DIRECTION_AXIAL
```
static final int SLICE_DIRECTION_AXIAL
```
    See Also:
    Constant Field Values
  - SLICE_DIRECTION_CORONAL
```
static final int SLICE_DIRECTION_CORONAL
```
    See Also:
    Constant Field Values
  - SLICE_DIRECTION_SAGITTAL
```
static final int SLICE_DIRECTION_SAGITTAL
```
    See Also:
    Constant Field Values
  - MASK_BLUE
```
static final long MASK_BLUE
```
    See Also:
    Constant Field Values
  - MASK_GREEN
```
static final long MASK_GREEN
```
    See Also:
    Constant Field Values
  - MASK_RED
```
static final long MASK_RED
```
    See Also:
    Constant Field Values
- Method Detail
  - addMaskValue
```
void addMaskValue(int xLoc,
                int yLoc,
                int zLoc,
                int tLoc,
                long mask)
```
    Adds an ROI value at a specified location. The call addROIValue(0, 0, 0, MASK_RED) is equivalent to replaceROIValue(0, 0, 0, getROIValue(0, 0, 0) | MASK_RED).
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    tLoc - the series index
    mask - the value to add
  - addMaskValue
```
void addMaskValue(int xLoc,
                int yLoc,
                int zLoc,
                long mask)
```
    Adds an ROI value at a specified location. The call addROIValue(0, 0, 0, MASK_RED) is equivalent to replaceROIValue(0, 0, 0, getROIValue(0, 0, 0) | MASK_RED).
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    mask - the value to add
  - addPoint
```
void addPoint(Coordinate point,
            int color)
```
    Adds a point.
    
    Parameters:
    point - the point to add
    color - the color index (e.g., RED_INDEX, GREEN_INDEX, etc)
  - addROIMaskValue
```
@Deprecated
void addROIMaskValue(int xLoc,
                              int yLoc,
                              int zLoc,
                              byte roiVal)
```
    Deprecated.
    
    Adds an ROI value at a specified XYZ index coordinate. An ROI value is a one-byte bit map representing the state of eight possible ROIs for a voxel. The call addROIValue(0, 0, 0, RED_MASK) is equivalent to replaceROIValue(0, 0, 0, getROIValue(0, 0, 0) | RED_MASK).
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    roiVal - the value to add
  - addROIMaskValue
```
@Deprecated
void addROIMaskValue(int xLoc,
                              int yLoc,
                              int zLoc,
                              int tLoc,
                              byte roiVal)
```
    Deprecated.
    
    Adds an ROI value at a specified XYZ index coordinate. An ROI value is a one-byte bit map representing the state of eight possible ROIs for a voxel. The call addROIValue(0, 0, 0, RED_MASK) is equivalent to replaceROIValue(0, 0, 0, getROIValue(0, 0, 0) | RED_MASK).
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    tLoc - the series index
    roiVal - the value to add
  - addShape
```
Shape addShape(int sliceDirection,
             int slice,
             int color,
             Shape shape)
```
    Add a shape of a specified color within a slice.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    slice - the slice index
    color - the color index (e.g., RED_INDEX, GREEN_INDEX, etc)
    shape - the shape to add
    
    Returns:
    the added shape
  - addSpecialPoint
```
void addSpecialPoint(Coordinate point,
                   Color color,
                   boolean editable)
```
    Adds a point with special properties that can only be removed programmatically.
    
    Parameters:
    point - the point to add
    color - the color value
    editable - true to make this point editable by the user
  - addSpecialShape
```
Shape addSpecialShape(int sliceDirection,
                    int slice,
                    Color color,
                    Shape shape,
                    Stroke stroke,
                    boolean editable,
                    boolean fixed)
```
    Add a shape with special properties that can only be remove programmatically.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    slice - the slice index (only relevant when fixed is false)
    color - the color value
    shape - the shape to add
    stroke - the shape stroke
    editable - true to make this shape editable by the user
    fixed - true to make this shape fixed across all slices (i.e., not associated with a particular slice)
    
    Returns:
    the added shape
  - createMask
```
long createMask(int colorIndex)
```
    Creates a bit mask for a ROI color.
    
    Parameters:
    colorIndex - the ROI color index
    
    Returns:
    a bit mask
  - getAllROIs
```
List<ROI> getAllROIs()
```
    Returns a list of all ROIs.
    
    Returns:
    a list of all ROIs
  - getAvailableMask
```
long getAvailableMask()
```
    If there exists selected mask, it returns getSelectedMask(), otherwise it returns getUsedMaks().
    
    Returns:
    the available mask
  - getLabelManager
```
LabelManager getLabelManager()
```
    Returns the ROI mask LabelManager.
    
    Returns:
    the ROI mask LabelManager
  - getMaskValue
```
long getMaskValue(int xLoc,
                int yLoc,
                int zLoc)
```
    Gets the ROI value at a specified location.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    
    Returns:
    the ROI value
  - getMaskValue
```
long getMaskValue(int xLoc,
                int yLoc,
                int zLoc,
                int tLoc)
```
    Gets the ROI value at a specified location.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    tLoc - the series index
    
    Returns:
    the ROI value
  - getPoints
```
Coordinate[] getPoints(int color)
```
    Gets all points of a specified color.
    
    Parameters:
    color - the color index (e.g., RED_INDEX, GREEN_INDEX, etc)
    
    Returns:
    an array of all points of the specified color
  - getROIColor
```
Color getROIColor(int colorIndex)
```
    Returns the color of this ROI.
    
    Parameters:
    colorIndex - the color index
    
    Returns:
    the Color
  - getROIDataBuffer
```
ROIMaskBuffer getROIDataBuffer()
```
    Returns the ROI data buffer. The ROI buffer is one greater in each dimension than the image dimensions. ROI buffer data is always stored in XYZ+-- data orientation.
    
    Returns:
    the ROIBuffer
  - getROILabel
```
String getROILabel(int colorIndex)
```
    Returns the label of this ROI.
    
    Parameters:
    colorIndex - the color index
    
    Returns:
    the label
  - getROIMaskBuffer
```
@Deprecated
ByteBuffer getROIMaskBuffer()
```
    Deprecated.
    
    Returns the ROI work buffer, for use with advanced methods. The ROI buffer is one greater in each dimension than the image dimensions. ROI buffer data is always stored in XYZ+-- data orientation.
    
    Returns:
    the ROI work buffer
  - getROIMaskValue
```
@Deprecated
byte getROIMaskValue(int xLoc,
                              int yLoc,
                              int zLoc)
```
    Deprecated.
    
    Gets an ROI value at a specified XYZ index coordinate. An ROI value is a one-byte bit map representing the state of eight possible ROIs for a voxel.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    
    Returns:
    the ROI value at the specified index coordinate
  - getROIMaskValue
```
@Deprecated
byte getROIMaskValue(int xLoc,
                              int yLoc,
                              int zLoc,
                              int tLoc)
```
    Deprecated.
    
    Gets an ROI value at a specified XYZ index coordinate. An ROI value is a one-byte bit map representing the state of eight possible ROIs for a voxel.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    tLoc - the series index
    
    Returns:
    the ROI value at the specified index coordinate
  - getROISelectedMask
```
@Deprecated
byte getROISelectedMask()
```
    Deprecated.
    
    Returns the "selected" state of the ROI mask.
    
    Returns:
    a byte mask
  - getROIUsedMask
```
@Deprecated
byte getROIUsedMask()
```
    Deprecated.
    
    Returns the "used" state of the ROI mask.
    
    Returns:
    a byte mask
  - getSelectedLines
```
List<Line> getSelectedLines()
```
    Returns a list of selected ROI lines.
    
    Returns:
    a list of selected ROI lines
  - getSelectedMask
```
long getSelectedMask()
```
    Returns a bit mask of selected ROI colors.
    
    Returns:
    a bit mask
  - getSelectedMasks
```
List<ROI> getSelectedMasks()
```
    Returns a list of selected ROI masks.
    
    Returns:
    a list of selected ROI masks
  - getSelectedPoints
```
List<Point> getSelectedPoints()
```
    Returns a list of selected ROI points.
    
    Returns:
    a list of selected ROI points
  - getSelectedROIs
```
List<ROI> getSelectedROIs()
```
    Returns a list of selected ROIs.
    
    Returns:
    a list of selected ROIs
  - getShapes
```
Shape[] getShapes(int sliceDirection,
                int slice,
                int color)
```
    Gets all shapes of a specified color within a slice. For example, getShapes(0, 0, 0) will return all shapes in the first axial slice matching color value 0.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    slice - the slice index
    color - the color index (e.g., RED_INDEX, GREEN_INDEX, etc)
    
    Returns:
    an array of Shapes or null if none are found
  - getSpecialPoints
```
Coordinate[] getSpecialPoints(Color color)
```
    Gets all special points of a specified color.
    
    Parameters:
    color - the color value
    
    Returns:
    an array of all points of the specified color
  - getSpecialShapes
```
Shape[] getSpecialShapes(int sliceDirection,
                       int slice,
                       Color color)
```
    Gets all special shapes of a specified color within a slice. For example, getShapes(0, 0, 0) will return all shapes in the first axial slice matching the Color.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    slice - the slice index
    color - the color value
    
    Returns:
    an array of Shapes or null if none are found
  - getUsedLines
```
List<Line> getUsedLines()
```
    Returns a list of used ROI lines.
    
    Returns:
    a list of used ROI lines
  - getUsedMask
```
long getUsedMask()
```
    Returns a bit mask of used ROI colors.
    
    Returns:
    a bit mask
  - getUsedMasks
```
List<ROI> getUsedMasks()
```
    Returns a list of used ROIs.
    
    Returns:
    a list of used ROIs
  - getUsedPoints
```
List<Point> getUsedPoints()
```
    Returns a list of used ROI points.
    
    Returns:
    a list of used ROI points
  - hasSelectedMaskInRange
```
boolean hasSelectedMaskInRange(int xMin,
                             int xMax,
                             int yMin,
                             int yMax,
                             int zMin,
                             int zMax)
```
    Test if there is a selected ROI mask in the specified bounds.
    
    Parameters:
    xMin - the X minimum
    xMax - the X maximum
    yMin - the Y minimum
    yMax - the Y maximum
    zMin - the Z minimum
    zMax - the Z maximum
    
    Returns:
    true if a selected ROI mask is found in the specified bounds, false otherwise
  - initMask
```
void initMask(long mask)
```
    Initializes one or more ROI colors. For example, initROIMask(ROIData.MASK_RED) or initROIMask(createMask(11)). This should be called before any calls to replaceROIMaskValue() or addROIMaskValue().
    
    Parameters:
    mask - the bit mask of all the ROI colors to initialize
  - initROIMask
```
@Deprecated
void initROIMask(byte mask)
```
    Deprecated.
    
    Initializes one or more ROI colors. For example, initROIMask(ROIData.MASK_RED). This should be called before any calls to replaceROIMaskValue() or addROIMaskValue().
    
    Parameters:
    mask - the bit mask of all the ROI colors to initialize
  - isInsideSelectedMaskAtOffset
```
boolean isInsideSelectedMaskAtOffset(int offset)
```
    Test if there is a selected ROI mask at the specified offset.
    
    Parameters:
    offset - the offset
    
    Returns:
    true if a selected ROI mask is found at the specified offset, false otherwise
  - removePoint
```
void removePoint(Coordinate point,
               int color)
```
    Removes a point.
    
    Parameters:
    point - the point to remove
    color - the color index (e.g., RED_INDEX, GREEN_INDEX, etc)
  - removeShape
```
void removeShape(int sliceDirection,
               Shape shape)
```
    Remove a shape.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    shape - the shape to remove
  - removeSpecialPoint
```
void removeSpecialPoint(Coordinate point,
                      Color color)
```
    Removes a special point.
    
    Parameters:
    point - the point to remove
    color - the color value
  - removeSpecialShape
```
void removeSpecialShape(int sliceDirection,
                      Shape shape)
```
    Remove a special shape.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    shape - the shape to remove
  - replaceMaskValue
```
void replaceMaskValue(int xLoc,
                    int yLoc,
                    int zLoc,
                    int tLoc,
                    long mask)
```
    Replace a ROI value at a specified location.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    tLoc - the series index
    mask - the value to write
  - replaceMaskValue
```
void replaceMaskValue(int xLoc,
                    int yLoc,
                    int zLoc,
                    long mask)
```
    Replace a ROI value at a specified location.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    mask - the value to write
  - replaceROIMaskValue
```
@Deprecated
void replaceROIMaskValue(int xLoc,
                                  int yLoc,
                                  int zLoc,
                                  byte roiVal)
```
    Deprecated.
    
    Replace an ROI value at a specified XYZ index coordinate. An ROI value is a one-byte bit map representing the state of eight possible ROIs for a voxel.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    roiVal - the value to write
  - replaceROIMaskValue
```
@Deprecated
void replaceROIMaskValue(int xLoc,
                                  int yLoc,
                                  int zLoc,
                                  int tLoc,
                                  byte roiVal)
```
    Deprecated.
    
    Replace an ROI value at a specified XYZ index coordinate. An ROI value is a one-byte bit map representing the state of eight possible ROIs for a voxel.
    
    Parameters:
    xLoc - the X index
    yLoc - the Y index
    zLoc - the Z index
    tLoc - the series index
    roiVal - the value to write
  - roiMaskOperationCompleted
```
void roiMaskOperationCompleted()
```
    Call this following an ROI operation (e.g., after iterating through the entire volume making changes).
  - roiMaskOperationCompleted
```
void roiMaskOperationCompleted(String des)
```
    Call this following an ROI operation (e.g., after iterating through the entire volume making changes).
    
    Parameters:
    des - message to log
  - setPointHighlightState
```
void setPointHighlightState(Coordinate point,
                          Color color,
                          boolean highlight)
```
    Sets the highlight state of a special point.
    
    Parameters:
    point - the point to change
    color - the color value
    highlight - true, to set as highlighted
  - setShapeHighlightState
```
void setShapeHighlightState(int sliceDirection,
                          Shape shape,
                          boolean highlight)
```
    Sets the highlight state of a special shape.
    
    Parameters:
    sliceDirection - SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTAL
    shape - the shape to change
    highlight - true, to set as highlighted
  - setUseROISeries
```
void setUseROISeries(boolean useROISeries)
```
    True to use a ROI series, false otherwise.
    
    Parameters:
    useROISeries - true to use a ROI series

Interface ROIData

Field Summary

Method Summary

Methods inherited from interface edu.uthscsa.ric.roi.ColorManager

Field Detail

BLUE_MASK

CYAN_MASK

GREEN_MASK

MAGENTA_MASK

ORANGE_MASK

RED_MASK

SLATE_MASK

YELLOW_MASK

BLUE_INDEX

CYAN_INDEX

GREEN_INDEX

MAGENTA_INDEX

ORANGE_INDEX

RED_INDEX

SLATE_INDEX

YELLOW_INDEX

MASL_BLUE

INDEX_BLUE

INDEX_GREEN

INDEX_RED

SLICE_DIRECTION_AXIAL

SLICE_DIRECTION_CORONAL

SLICE_DIRECTION_SAGITTAL

MASK_BLUE

MASK_GREEN

MASK_RED

Method Detail

addMaskValue

addMaskValue

addPoint

addROIMaskValue

addROIMaskValue

addShape

addSpecialPoint

addSpecialShape

createMask

getAllROIs

getAvailableMask

getLabelManager

getMaskValue

getMaskValue

getPoints

getROIColor

getROIDataBuffer

getROILabel

getROIMaskBuffer

getROIMaskValue

getROIMaskValue

getROISelectedMask

getROIUsedMask

getSelectedLines

getSelectedMask

getSelectedMasks

getSelectedPoints

getSelectedROIs

getShapes

getSpecialPoints

getSpecialShapes

getUsedLines

getUsedMask

getUsedMasks

getUsedPoints

hasSelectedMaskInRange

initMask

initROIMask

isInsideSelectedMaskAtOffset

removePoint

removeShape

removeSpecialPoint

removeSpecialShape

replaceMaskValue

replaceMaskValue

replaceROIMaskValue

replaceROIMaskValue

roiMaskOperationCompleted