public interface ROIData extends ColorManager
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.
|
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.
|
getMaximumColors, isSelected, isUsed
@Deprecated static final byte BLUE_MASK
@Deprecated static final byte CYAN_MASK
@Deprecated static final byte GREEN_MASK
@Deprecated static final byte MAGENTA_MASK
@Deprecated static final byte ORANGE_MASK
@Deprecated static final byte RED_MASK
@Deprecated static final byte SLATE_MASK
@Deprecated static final byte YELLOW_MASK
@Deprecated static final int BLUE_INDEX
@Deprecated static final int CYAN_INDEX
@Deprecated static final int GREEN_INDEX
@Deprecated static final int MAGENTA_INDEX
@Deprecated static final int ORANGE_INDEX
@Deprecated static final int RED_INDEX
@Deprecated static final int SLATE_INDEX
@Deprecated static final int YELLOW_INDEX
@Deprecated static final long MASL_BLUE
static final int INDEX_BLUE
static final int INDEX_GREEN
static final int INDEX_RED
static final int SLICE_DIRECTION_AXIAL
static final int SLICE_DIRECTION_CORONAL
static final int SLICE_DIRECTION_SAGITTAL
static final long MASK_BLUE
static final long MASK_GREEN
static final long MASK_RED
void addMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, long mask)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indextLoc
- the series indexmask
- the value to addvoid addMaskValue(int xLoc, int yLoc, int zLoc, long mask)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indexmask
- the value to addvoid addPoint(Coordinate point, int color)
point
- the point to addcolor
- the color index (e.g., RED_INDEX, GREEN_INDEX, etc)@Deprecated void addROIMaskValue(int xLoc, int yLoc, int zLoc, byte roiVal)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indexroiVal
- the value to add@Deprecated void addROIMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, byte roiVal)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indextLoc
- the series indexroiVal
- the value to addShape addShape(int sliceDirection, int slice, int color, Shape shape)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALslice
- the slice indexcolor
- the color index (e.g., RED_INDEX, GREEN_INDEX, etc)shape
- the shape to addvoid addSpecialPoint(Coordinate point, Color color, boolean editable)
point
- the point to addcolor
- the color valueeditable
- true to make this point editable by the userShape addSpecialShape(int sliceDirection, int slice, Color color, Shape shape, Stroke stroke, boolean editable, boolean fixed)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALslice
- the slice index (only relevant when fixed is false)color
- the color valueshape
- the shape to addstroke
- the shape strokeeditable
- true to make this shape editable by the userfixed
- true to make this shape fixed across all slices (i.e., not associated with a particular slice)long createMask(int colorIndex)
colorIndex
- the ROI color indexlong getAvailableMask()
LabelManager getLabelManager()
long getMaskValue(int xLoc, int yLoc, int zLoc)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indexlong getMaskValue(int xLoc, int yLoc, int zLoc, int tLoc)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indextLoc
- the series indexCoordinate[] getPoints(int color)
color
- the color index (e.g., RED_INDEX, GREEN_INDEX, etc)Color getROIColor(int colorIndex)
colorIndex
- the color indexROIMaskBuffer getROIDataBuffer()
String getROILabel(int colorIndex)
colorIndex
- the color index@Deprecated ByteBuffer getROIMaskBuffer()
@Deprecated byte getROIMaskValue(int xLoc, int yLoc, int zLoc)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z index@Deprecated byte getROIMaskValue(int xLoc, int yLoc, int zLoc, int tLoc)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indextLoc
- the series index@Deprecated byte getROISelectedMask()
@Deprecated byte getROIUsedMask()
List<Line> getSelectedLines()
long getSelectedMask()
List<ROI> getSelectedMasks()
List<Point> getSelectedPoints()
List<ROI> getSelectedROIs()
Shape[] getShapes(int sliceDirection, int slice, int color)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALslice
- the slice indexcolor
- the color index (e.g., RED_INDEX, GREEN_INDEX, etc)Coordinate[] getSpecialPoints(Color color)
color
- the color valueShape[] getSpecialShapes(int sliceDirection, int slice, Color color)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALslice
- the slice indexcolor
- the color valueList<Line> getUsedLines()
long getUsedMask()
List<Point> getUsedPoints()
boolean hasSelectedMaskInRange(int xMin, int xMax, int yMin, int yMax, int zMin, int zMax)
xMin
- the X minimumxMax
- the X maximumyMin
- the Y minimumyMax
- the Y maximumzMin
- the Z minimumzMax
- the Z maximumvoid initMask(long mask)
mask
- the bit mask of all the ROI colors to initialize@Deprecated void initROIMask(byte mask)
mask
- the bit mask of all the ROI colors to initializeboolean isInsideSelectedMaskAtOffset(int offset)
offset
- the offsetvoid removePoint(Coordinate point, int color)
point
- the point to removecolor
- the color index (e.g., RED_INDEX, GREEN_INDEX, etc)void removeShape(int sliceDirection, Shape shape)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALshape
- the shape to removevoid removeSpecialPoint(Coordinate point, Color color)
point
- the point to removecolor
- the color valuevoid removeSpecialShape(int sliceDirection, Shape shape)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALshape
- the shape to removevoid replaceMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, long mask)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indextLoc
- the series indexmask
- the value to writevoid replaceMaskValue(int xLoc, int yLoc, int zLoc, long mask)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indexmask
- the value to write@Deprecated void replaceROIMaskValue(int xLoc, int yLoc, int zLoc, byte roiVal)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indexroiVal
- the value to write@Deprecated void replaceROIMaskValue(int xLoc, int yLoc, int zLoc, int tLoc, byte roiVal)
xLoc
- the X indexyLoc
- the Y indexzLoc
- the Z indextLoc
- the series indexroiVal
- the value to writevoid roiMaskOperationCompleted()
void roiMaskOperationCompleted(String des)
des
- message to logvoid setPointHighlightState(Coordinate point, Color color, boolean highlight)
point
- the point to changecolor
- the color valuehighlight
- true, to set as highlightedvoid setShapeHighlightState(int sliceDirection, Shape shape, boolean highlight)
sliceDirection
- SLICE_DIRECTION_AXIAL, SLICE_DIRECTION_CORONAL, or SLICE_DIRECTION_SAGITTALshape
- the shape to changehighlight
- true, to set as highlightedvoid setUseROISeries(boolean useROISeries)
useROISeries
- true to use a ROI series