Package ij.gui
Class Overlay
- java.lang.Object
-
- ij.gui.Overlay
-
public class Overlay extends Object
An Overlay is a list of ROIs that can be drawn non-destructively on an Image.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.Roi
get(String name)
Returns the ROI with the specified name or null if not found.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()
boolean
isSelectable()
Returns 'true' if ROIs in this overlay can be activated by clicking on their labels or by a long press.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.boolean
scalableLabels()
void
selectable(boolean selectable)
Set 'false' to prevent ROIs in this overlay from being activated by clicking on their labels or by a long clicking.void
set(Roi roi, int index)
Replaces the ROI at the specified index.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
setLabelFont(Font font, boolean scalable)
void
setLabelFontSize(int size, String options)
Set the label font size with options.void
setStrokeColor(Color color)
Sets the stroke color of all the ROIs in this overlay.void
setStrokeWidth(Double width)
Sets the stroke width 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.
-
-
-
Constructor Detail
-
Overlay
public Overlay()
Constructs an empty Overlay.
-
Overlay
public Overlay(Roi roi)
Constructs an Overlay and adds the specified ROI.
-
-
Method Detail
-
add
public void add(Roi roi)
Adds an ROI to this Overlay.
-
addElement
public void addElement(Roi roi)
Adds an ROI to this Overlay.
-
set
public void set(Roi roi, int index)
Replaces the ROI at the specified index.
-
remove
public void remove(int index)
Removes the ROI with the specified index from this Overlay.
-
remove
public void remove(Roi roi)
Removes the specified ROI from this Overlay.
-
remove
public void remove(String name)
Removes all ROIs that have the specified name.
-
clear
public void clear()
Removes all the ROIs in this Overlay.
-
get
public Roi get(int index)
Returns the ROI with the specified index or null if the index is invalid.
-
getIndex
public int getIndex(String name)
Returns the index of the ROI with the specified name, or -1 if not found.
-
contains
public boolean contains(Roi roi)
Returns 'true' if this Overlay contains the specified ROI.
-
size
public int size()
Returns the number of ROIs in this Overlay.
-
toArray
public Roi[] toArray()
Returns on array containing the ROIs in this Overlay.
-
setStrokeColor
public void setStrokeColor(Color color)
Sets the stroke color of all the ROIs in this overlay.
-
setStrokeWidth
public void setStrokeWidth(Double width)
Sets the stroke width of all the ROIs in this overlay.
-
setFillColor
public void setFillColor(Color color)
Sets the fill color of all the ROIs in this overlay.
-
translate
public void translate(int dx, int dy)
Moves all the ROIs in this overlay.
-
translate
public void translate(double dx, double dy)
Moves all the ROIs in this overlay. Marcel Boeglin, October 2013
-
measure
public ResultsTable measure(ImagePlus imp)
Measures the ROIs in this overlay on the specified image and returns the results as a ResultsTable.
-
crop
public void crop(int firstSlice, int lastSlice)
Removes ROIs having positions outside of the interval defined by firstSlice and lastSlice. Marcel Boeglin, September 2013
-
crop
public 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. Marcel Boeglin, September 2013
-
create
public Overlay create()
Returns a new Overlay that has the same properties as this one.
-
duplicate
public Overlay duplicate()
Returns a clone of this Overlay.
-
drawLabels
public void drawLabels(boolean b)
-
getDrawLabels
public boolean getDrawLabels()
-
drawNames
public void drawNames(boolean b)
-
getDrawNames
public boolean getDrawNames()
-
drawBackgrounds
public void drawBackgrounds(boolean b)
-
getDrawBackgrounds
public boolean getDrawBackgrounds()
-
setLabelColor
public void setLabelColor(Color c)
-
getLabelColor
public Color getLabelColor()
-
setLabelFont
public void setLabelFont(Font font)
-
setLabelFont
public void setLabelFont(Font font, boolean scalable)
-
setLabelFontSize
public void setLabelFontSize(int size, String options)
Set the label font size with options. The options string can contain 'scale' (enlarge labels when image zoomed), 'bold' (display bold labels) or 'background' (display labels with contrasting background.
-
getLabelFont
public Font getLabelFont()
-
setIsCalibrationBar
public void setIsCalibrationBar(boolean b)
-
isCalibrationBar
public boolean isCalibrationBar()
-
selectable
public void selectable(boolean selectable)
Set 'false' to prevent ROIs in this overlay from being activated by clicking on their labels or by a long clicking.
-
isSelectable
public boolean isSelectable()
Returns 'true' if ROIs in this overlay can be activated by clicking on their labels or by a long press.
-
scalableLabels
public boolean scalableLabels()
-
-