public class Overlay extends Object
Constructor and Description |
---|
Overlay()
Constructs an empty Overlay.
|
Overlay(Roi roi)
Constructs an Overlay and adds the specified ROI.
|
Modifier and Type | Method and Description |
---|---|
void |
add(Roi roi)
Adds an ROI to this Overlay.
|
void |
add(Roi roi,
String name)
Adds an ROI to this Overlay using the specified name.
|
void |
addElement(Roi roi)
Adds an ROI to this Overlay.
|
void |
clear()
Removes all the ROIs in this Overlay.
|
boolean |
contains(Roi roi)
Returns 'true' if this Overlay contains the specified ROI.
|
Overlay |
create()
Returns a new Overlay that has the same properties as this one.
|
void |
crop(int firstSlice,
int lastSlice)
Removes ROIs having positions outside of the
interval defined by firstSlice and lastSlice.
|
void |
crop(int firstC,
int lastC,
int firstZ,
int lastZ,
int firstT,
int lastT)
Removes ROIs having a C, Z or T coordinate outside the volume
defined by firstC, lastC, firstZ, lastZ, firstT and lastT.
|
Overlay |
crop(Rectangle bounds) |
void |
drawBackgrounds(boolean b) |
void |
drawLabels(boolean b) |
void |
drawNames(boolean b) |
Overlay |
duplicate()
Returns a clone of this Overlay.
|
Roi |
get(int index)
Returns the ROI with the specified index or null if the index is invalid.
|
boolean |
getDrawBackgrounds() |
boolean |
getDrawLabels() |
boolean |
getDrawNames() |
int |
getIndex(String name)
Returns the index of the ROI with the specified name, or -1 if not found.
|
Color |
getLabelColor() |
Font |
getLabelFont() |
boolean |
isCalibrationBar() |
ResultsTable |
measure(ImagePlus imp)
Measures the ROIs in this overlay on the specified image
and returns the results as a ResultsTable.
|
void |
remove(int index)
Removes the ROI with the specified index from this Overlay.
|
void |
remove(Roi roi)
Removes the specified ROI from this Overlay.
|
void |
remove(String name)
Removes all ROIs that have the specified name.
|
void |
setFillColor(Color color)
Sets the fill color of all the ROIs in this overlay.
|
void |
setIsCalibrationBar(boolean b) |
void |
setLabelColor(Color c) |
void |
setLabelFont(Font font) |
void |
setStrokeColor(Color color)
Sets the stroke color of all the ROIs in this overlay.
|
int |
size()
Returns the number of ROIs in this Overlay.
|
Roi[] |
toArray()
Returns on array containing the ROIs in this Overlay.
|
String |
toString() |
void |
translate(double dx,
double dy)
Moves all the ROIs in this overlay.
|
void |
translate(int dx,
int dy)
Moves all the ROIs in this overlay.
|
public Overlay()
public Overlay(Roi roi)
public void add(Roi roi)
public void addElement(Roi roi)
public void remove(int index)
public void remove(Roi roi)
public void remove(String name)
public void clear()
public Roi get(int index)
public int getIndex(String name)
public boolean contains(Roi roi)
public int size()
public Roi[] toArray()
public void setStrokeColor(Color color)
public void setFillColor(Color color)
public void translate(int dx, int dy)
public void translate(double dx, double dy)
public ResultsTable measure(ImagePlus imp)
public void crop(int firstSlice, int lastSlice)
public void crop(int firstC, int lastC, int firstZ, int lastZ, int firstT, int lastT)
public Overlay create()
public Overlay duplicate()
public void drawLabels(boolean b)
public boolean getDrawLabels()
public void drawNames(boolean b)
public boolean getDrawNames()
public void drawBackgrounds(boolean b)
public boolean getDrawBackgrounds()
public void setLabelColor(Color c)
public Color getLabelColor()
public void setLabelFont(Font font)
public Font getLabelFont()
public void setIsCalibrationBar(boolean b)
public boolean isCalibrationBar()