ROIMaskBuffer (Mango Plugin API)

```
public interface ROIMaskBuffer
```
A ROI data buffer.

Author:

michaelmartinez

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`get(int offset, int index)` Returns the ROI mask value at the specified offset and series index.
`long`	`getCurrent(int offset)` Returns the ROI mask value at the specified offset for the current series index.
`int`	`getMaximumColors()` Returns the maximum number of ROI colors that this buffer supports.
`ImageBounds`	`getROIBounds(long mask, int index)` Returns the ImageBounds of the specified mask and series index.
`ImageBounds`	`getROIBoundsCurrent(long mask)` Returns the ImageBounds of the specified mask for the current series index.
`int`	`getSeriesIndex()` Returns the current ROI series index.
`int`	`getSeriesLength()` Returns the length of the ROI series.
`boolean`	`isEmptyOf(int roiNum)` Returns true if the ROI color index is not found.
`void`	`put(int offset, int index, long val)` Sets a mask value at a specified offset and series index.
`void`	`putCurrent(int offset, long val)` Sets a mask value at a specified offset for the current series index.

- Method Detail
  - get
```
long get(int offset,
       int index)
```
    Returns the ROI mask value at the specified offset and series index.
    
    Parameters:
    offset - volume offset
    index - series index
    
    Returns:
    the mask value
  - getCurrent
```
long getCurrent(int offset)
```
    Returns the ROI mask value at the specified offset for the current series index.
    
    Parameters:
    offset - volume offset
    
    Returns:
    the mask value
  - getMaximumColors
```
int getMaximumColors()
```
    Returns the maximum number of ROI colors that this buffer supports.
    
    Returns:
    the maximum number of ROI colors that this buffer supports
  - getROIBounds
```
ImageBounds getROIBounds(long mask,
                       int index)
```
    Returns the ImageBounds of the specified mask and series index.
    
    Parameters:
    mask - a bit mask
    index - series index
    
    Returns:
    the ImageBounds the mask
  - getROIBoundsCurrent
```
ImageBounds getROIBoundsCurrent(long mask)
```
    Returns the ImageBounds of the specified mask for the current series index.
    
    Parameters:
    mask - a bit mask
    
    Returns:
    the ImageBounds of the mask
  - getSeriesIndex
```
int getSeriesIndex()
```
    Returns the current ROI series index.
    
    Returns:
    the current ROI series index
  - getSeriesLength
```
int getSeriesLength()
```
    Returns the length of the ROI series.
    
    Returns:
    the length of the ROI series
  - isEmptyOf
```
boolean isEmptyOf(int roiNum)
```
    Returns true if the ROI color index is not found.
    
    Parameters:
    roiNum - color index
    
    Returns:
    true if the ROI color index is not found
  - put
```
void put(int offset,
       int index,
       long val)
```
    Sets a mask value at a specified offset and series index.
    
    Parameters:
    offset - volume offset
    index - series index
    val - the mask value
  - putCurrent
```
void putCurrent(int offset,
              long val)
```
    Sets a mask value at a specified offset for the current series index.
    
    Parameters:
    offset - volume offset
    val - the mask value

Interface ROIMaskBuffer

Method Summary

Method Detail

get

getCurrent

getMaximumColors

getROIBounds

getROIBoundsCurrent

getSeriesIndex

getSeriesLength

isEmptyOf

put

putCurrent