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.
  • Constructor Details

    • Overlay

      public Overlay()
      Constructs an empty Overlay.
    • Overlay

      public Overlay(Roi roi)
      Constructs an Overlay and adds the specified ROI.
  • Method Details

    • add

      public void add(Roi roi)
      Adds an ROI to this Overlay.
    • add

      public void add(Roi roi, String name)
      Adds an ROI to this Overlay using the specified name.
    • addElement

      public void addElement(Roi roi)
      Adds an ROI to this Overlay.
    • 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.
    • 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
    • crop

      public Overlay crop(Rectangle bounds)
    • 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.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • 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)
    • getLabelFont

      public Font getLabelFont()
    • setIsCalibrationBar

      public void setIsCalibrationBar(boolean b)
    • isCalibrationBar

      public boolean isCalibrationBar()