RoiListOverlay (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- trainableSegmentation.RoiListOverlay

All Implemented Interfaces:

OverlayedImageCanvas.Overlay
```
public class RoiListOverlay
extends Object
implements OverlayedImageCanvas.Overlay
```
This class implements an overlay based on the image ROI. The overlay paints the ROI with a specific color and composite mode.

Author:

Ignacio Arganda-Carreras

Constructor Summary

Constructors
Constructor and Description
`RoiListOverlay()` Empty constructor
`RoiListOverlay(ArrayList<Roi> roi, Composite composite, Color color)` Create a RoiOverlay based on a Roi and a specific color and composite mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`paint(Graphics g, int x, int y, double magnification)` Paint this overlay on the given graphic device.
`void`	`setColor(Color color)` Set the color of the ROIs
`void`	`setComposite(Composite composite)` Set the composite to be used in the overlay.
`void`	`setRoi(ArrayList<Roi> roi)` Set the list of ROIs.
`String`	`toString()` Convert the list of ROIs to text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RoiListOverlay
```
public RoiListOverlay()
```
    Empty constructor
  - RoiListOverlay
```
public RoiListOverlay(ArrayList<Roi> roi,
                      Composite composite,
                      Color color)
```
    Create a RoiOverlay based on a Roi and a specific color and composite mode.
    
    Parameters:
    
    roi - original image region of interest
    
    composite - composite mode
    
    color - color to paint the RoiOverlay
- Method Detail
  - paint
```
public void paint(Graphics g,
                  int x,
                  int y,
                  double magnification)
```
    Description copied from interface: OverlayedImageCanvas.Overlay
    
    Paint this overlay on the given graphic device.
    
    Specified by:
    
    paint in interface OverlayedImageCanvas.Overlay
    
    Parameters:
    
    g - the graphic device provided by the OverlayedImageCanvas
    
    x - the top-left corner x-coordinate of the image rectangle currently displayed in the OverlayedImageCanvas
    
    y - the top-left corner y-coordinate
    
    magnification - the OverlayedImageCanvas current magnification
  - setRoi
```
public void setRoi(ArrayList<Roi> roi)
```
    Set the list of ROIs.
    
    Parameters:
    
    roi - list of ROIs to be displayed
  - setComposite
```
public void setComposite(Composite composite)
```
    Set the composite to be used in the overlay.
    
    Specified by:
    
    setComposite in interface OverlayedImageCanvas.Overlay
    
    Parameters:
    
    composite - composite to be used in the overlay
  - setColor
```
public void setColor(Color color)
```
    Set the color of the ROIs
    
    Parameters:
    
    color - ROI color
  - toString
```
public String toString()
```
    Convert the list of ROIs to text.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string containing the list of ROIs

Class RoiListOverlay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoiListOverlay

RoiListOverlay

Method Detail

paint

setRoi

setComposite

setColor

toString