O2Plib.image
Class RoiList

java.lang.Object
  extended by O2Plib.image.RoiList

public class RoiList
extends java.lang.Object


Field Summary
 java.awt.Color color
          working Roi color.
static int DEF_MAX_ROIS
          max # of Rois
 int maxRoi
          max roi, max array size.
 int nRoi
          current number of ROIs in the roiList[]
 Roi[] roiList
          Roi list of size [0:nRoi-1]
 Roi roiWORKING
          Internal "WORKING",ROI_WORKING instance that can be used to set the CW, DBUG or PIXDUMP (not the ND) Rois
 boolean[] showRoiFlag
          flags for displaying roi
 
Constructor Summary
RoiList()
          RoiList() - Constructor using DEF_MAX_ROIS
RoiList(int maxSize)
          RoiList() - Constructor where size is specified.
 
Method Summary
 boolean addRoi(Roi newRoi, boolean showRoiFlag, int roiCode, java.awt.Color color)
          addRoi() - add new Roi to Roi list
 boolean containsRoi(java.lang.String roiName)
          containsRoi() - see if roiName is in RoiList
 void setRoiList(int maxSize)
          setRoiList() - set up Roi list
 boolean setSingleROItoDisplay(int roiCode)
          setSingleROItoDisplay() - set one ROI for display
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEF_MAX_ROIS

public static final int DEF_MAX_ROIS
max # of Rois

See Also:
Constant Field Values

maxRoi

public int maxRoi
max roi, max array size. Default is 10


roiList

public Roi[] roiList
Roi list of size [0:nRoi-1]


showRoiFlag

public boolean[] showRoiFlag
flags for displaying roi


nRoi

public int nRoi
current number of ROIs in the roiList[]


color

public java.awt.Color color
working Roi color. Default is red.


roiWORKING

public Roi roiWORKING
Internal "WORKING",ROI_WORKING instance that can be used to set the CW, DBUG or PIXDUMP (not the ND) Rois

Constructor Detail

RoiList

public RoiList(int maxSize)
RoiList() - Constructor where size is specified.

Parameters:
maxSize - is the maximum size of the roiList.

RoiList

public RoiList()
RoiList() - Constructor using DEF_MAX_ROIS

Method Detail

setRoiList

public void setRoiList(int maxSize)
setRoiList() - set up Roi list

Parameters:
maxSize - is the maximum size of the roiList.

setSingleROItoDisplay

public boolean setSingleROItoDisplay(int roiCode)
setSingleROItoDisplay() - set one ROI for display

Parameters:
code - is the ROI_xxxx code found in Sg2showImage class

addRoi

public boolean addRoi(Roi newRoi,
                      boolean showRoiFlag,
                      int roiCode,
                      java.awt.Color color)
addRoi() - add new Roi to Roi list

Parameters:
newRoi - ROI to add to Roi list
showRoiFlag - to specify if Roi should be displayed
newRoi - ROI to add to Roi list
newRoi - ROI to add to Roi list

containsRoi

public boolean containsRoi(java.lang.String roiName)
containsRoi() - see if roiName is in RoiList

Parameters:
roiName - name of roi to look for
Returns:
true if found false if problem of not found