Package ij.gui
Class Overlay
java.lang.Object
ij.gui.Overlay
An Overlay is a list of ROIs that can be drawn non-destructively on an Image.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an ROI to this Overlay.void
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
Returns 'true' if this Overlay contains the specified ROI.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.void
drawBackgrounds
(boolean b) void
drawLabels
(boolean b) void
drawNames
(boolean b) Returns a clone of this Overlay.get
(int index) Returns the ROI with the specified index or null if the index is invalid.boolean
boolean
boolean
int
Returns the index of the ROI with the specified name, or -1 if not found.boolean
void
remove
(int index) Removes the ROI with the specified index from this Overlay.void
Removes the specified ROI from this Overlay.void
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
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.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 Details
-
Overlay
public Overlay()Constructs an empty Overlay. -
Overlay
Constructs an Overlay and adds the specified ROI.
-
-
Method Details
-
add
Adds an ROI to this Overlay. -
add
Adds an ROI to this Overlay using the specified name. -
addElement
Adds an ROI to this Overlay. -
remove
public void remove(int index) Removes the ROI with the specified index from this Overlay. -
remove
Removes the specified ROI from this Overlay. -
remove
Removes all ROIs that have the specified name. -
clear
public void clear()Removes all the ROIs in this Overlay. -
get
Returns the ROI with the specified index or null if the index is invalid. -
getIndex
Returns the index of the ROI with the specified name, or -1 if not found. -
contains
Returns 'true' if this Overlay contains the specified ROI. -
size
public int size()Returns the number of ROIs in this Overlay. -
toArray
Returns on array containing the ROIs in this Overlay. -
setStrokeColor
Sets the stroke color of all the ROIs in this overlay. -
setFillColor
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 -
crop
-
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
Returns a new Overlay that has the same properties as this one. -
duplicate
Returns a clone of this Overlay. -
toString
-
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
-
getLabelColor
-
setLabelFont
-
getLabelFont
-
setIsCalibrationBar
public void setIsCalibrationBar(boolean b) -
isCalibrationBar
public boolean isCalibrationBar()
-