Roi (NDViewer image viewer 0.9.1 API)

java.lang.Object
- org.micromanager.ndviewer.overlay.Roi

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

Line, OvalRoi, TextRoi
```
public class Roi
extends Object
implements Cloneable, Serializable
```
A rectangular region of interest and superclass for the other ROI classes. This class implements Iterable<Point> and can thus be used to iterate over the contained coordinates. Usage example:
```
 Roi roi = ...;
 for (Point p : roi) {
   // process p
 }
 
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANGLE`
`protected double`	`asp_bk`
`protected boolean`	`aspect`
`protected boolean`	`center`
`protected int`	`clipHeight`
`protected int`	`clipWidth`
`protected int`	`clipX`
`protected int`	`clipY`
`static int`	`COMPOSITE`
`protected boolean`	`constrain`
`static int`	`CONSTRUCTING`
`protected static Color`	`defaultFillColor`
`protected Color`	`fillColor`
`static int`	`FREELINE`
`static int`	`FREEROI`
`static int`	`HANDLE_SIZE`
`protected Color`	`handleColor`
`protected boolean`	`ignoreClipRect`
`protected Color`	`instanceColor`
`static int`	`LINE`
`protected static int`	`lineWidth`
`protected double`	`mag`
`static int`	`MOVING`
`static int`	`MOVING_HANDLE`
`protected boolean`	`nonScalable`
`static int`	`NORMAL`
`static int`	`NOT_PASTING`
`protected int`	`oldHeight`
`protected int`	`oldWidth`
`protected int`	`oldX`
`protected int`	`oldY`
`static BasicStroke`	`onePixelWide`
`static int`	`OVAL`
`protected boolean`	`overlay`
`static int`	`POINT`
`static int`	`POLYGON`
`static int`	`POLYLINE`
`static Roi`	`previousRoi`
`static int`	`RECTANGLE`
`static int`	`RESIZING`
`protected static Color`	`ROIColor`
`protected BasicStroke`	`stroke`
`protected Color`	`strokeColor`
`static int`	`TRACED_ROI`
`protected int`	`type`
`protected boolean`	`updateFullWindow`
`protected boolean`	`wideLine`
`protected int`	`xMax`
`protected int`	`yMax`

Constructor Summary

Constructors
Constructor and Description
`Roi(double x, double y, double width, double height)` Creates a rectangular ROI using double arguments.
`Roi(double x, double y, double width, double height, int cornerDiameter)` Creates a rounded rectangular ROI using double arguments.
`Roi(int x, int y, int width, int height)` Creates a rectangular ROI.
`Roi(int x, int y, int width, int height, int cornerDiameter)` Creates a new rounded rectangular ROI.
`Roi(Rectangle r)` Creates a new rectangular Roi.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected int`	`clipRectMargin()`
`boolean`	`contains(int x, int y)`
`void`	`copyAttributes(Roi roi2)` Copy the attributes (outline color, fill color, outline width) of 'roi2' to the this selection.
`void`	`draw(Graphics g)`
`void`	`drawOverlay(Graphics g)`
`void`	`enableSubPixelResolution()`
`double`	`getAngle()` Overridden by PolygonRoi (angle between first two points), TextRoi (text angle) and Line (line angle).
`Rectangle`	`getBoundingRect()` Deprecated. replaced by getBounds()
`Rectangle`	`getBounds()` Return this selection's bounding rectangle.
`static Color`	`getColor()` Returns the default (global) color used for drawing ROI outlines.
`Polygon`	`getConvexHull()`
`int`	`getCornerDiameter()` Returns the rounded rectangle corner diameter (pixels).
`int`	`getCPosition()` Returns the channel position of this ROI, or zero if this ROI is not associated with a particular channel.
`String`	`getDebugInfo()`
`static Color`	`getDefaultFillColor()`
`boolean`	`getDrawOffset()` Returns true if this is a PolygonRoi that supports sub-pixel resolution and polygons are drawn on zoomed images offset down and to the right by 0.5 pixels..
`Color`	`getFillColor()` Returns the fill color used to display this ROI, or null if it is displayed transparently.
`Rectangle2D.Double`	`getFloatBounds()` Return this selection's bounding rectangle.
`double`	`getFloatHeight()`
`double`	`getFloatWidth()`
`int`	`getHashCode()` Returns a hashcode for this Roi that typically changes if it is moved, even though it is still the same object.
`String`	`getName()` Returns the name of this ROI, or null.
`Polygon`	`getPolygon()` Returns the outline of this selection as a Polygon, or null if this is a straight line selection.
`int`	`getPosition()` Returns the stack position (image number) of this ROI, or zero if the ROI is not associated with a particular stack image.
`String`	`getProperties()`
`String`	`getProperty(String property)`
`int`	`getPropertyCount()`
`Overlay`	`getPrototypeOverlay()`
`int`	`getRoundRectArcSize()` Obsolete; replaced by getCornerDiameter().
`int`	`getState()`
`BasicStroke`	`getStroke()` Returns the Stroke used to draw this ROI, or null if no Stroke is used.
`Color`	`getStrokeColor()` Returns the the color used to draw the ROI outline or null if the default color is being used.
`float`	`getStrokeWidth()` Returns the lineWidth.
`int`	`getTPosition()` Returns the frame position of this ROI, or zero if this ROI is not associated with a particular frame.
`int`	`getType()`
`String`	`getTypeAsString()` Convenience method that converts Roi type to a human-readable form.
`double`	`getXBase()`
`double`	`getYBase()`
`int`	`getZPosition()` Returns the slice position of this ROI, or zero if this ROI is not associated with a particular slice.
`boolean`	`isArea()` Returns 'true' if this is an area selection.
`boolean`	`isCursor()`
`boolean`	`isDrawingTool()` Returns 'true' if this is an ROI primarily used from drawing (e.g., TextRoi or Arrow).
`boolean`	`isLine()` Returns 'true' if this is a line selection.
`static void`	`setColor(Color c)` Sets the default (global) color used for ROI outlines.
`void`	`setCornerDiameter(int cornerDiameter)` Sets the rounded rectangle corner diameter (pixels).
`static void`	`setDefaultFillColor(Color color)`
`void`	`setDrawOffset(boolean drawOffset)`
`void`	`setFillColor(Color color)` Sets the fill color used to display this ROI, or set to null to display it transparently.
`void`	`setIgnoreClipRect(boolean ignoreClipRect)`
`void`	`setIsCursor(boolean isCursor)`
`void`	`setLocation(double x, double y)` Set the location of the ROI in image coordinates.
`void`	`setLocation(int x, int y)` Set the location of the ROI in image coordinates.
`void`	`setName(String name)` Sets the name of this ROI.
`void`	`setNonScalable(boolean nonScalable)` Set 'nonScalable' true to have TextRois in a display list drawn at a fixed location and size.
`void`	`setPosition(int n)` Sets the stack position (image number) of this ROI.
`void`	`setPosition(int channel, int slice, int frame)` Sets the hyperstack position of this ROI.
`void`	`setProperty(String key, String value)`
`void`	`setPrototypeOverlay(Overlay overlay)`
`void`	`setRotationCenter(double x, double y)`
`void`	`setRoundRectArcSize(int cornerDiameter)` Obsolete; replaced by setCornerDiameter().
`void`	`setStroke(BasicStroke stroke)` Sets the Stroke used to draw this ROI.
`void`	`setStrokeColor(Color c)` Sets the color used by this ROI to draw its outline.
`void`	`setStrokeWidth(double width)` This is a version of setStrokeWidth() that accepts a double argument.
`void`	`setStrokeWidth(float width)` Sets the width of the line used to draw this ROI.
`boolean`	`subPixelResolution()` Returns true if this is a slection that supports sub-pixel resolution.
`void`	`temporarilyHide()` Deprecated
`static float[]`	`toFloat(int[] arr)` Converts an int array to a float array.
`static int[]`	`toInt(float[] arr)` Converts a float array to an int array using truncation.
`static int[]`	`toInt(float[] arr, int[] arr2, int size)`
`static int[]`	`toIntR(float[] arr)` Converts a float array to an int array using rounding.
`String`	`toString()`

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

- Field Detail
  - CONSTRUCTING
```
public static final int CONSTRUCTING
```
    See Also:
    
    Constant Field Values
  - MOVING
```
public static final int MOVING
```
    See Also:
    
    Constant Field Values
  - RESIZING
```
public static final int RESIZING
```
    See Also:
    
    Constant Field Values
  - NORMAL
```
public static final int NORMAL
```
    See Also:
    
    Constant Field Values
  - MOVING_HANDLE
```
public static final int MOVING_HANDLE
```
    See Also:
    
    Constant Field Values
  - RECTANGLE
```
public static final int RECTANGLE
```
    See Also:
    
    Constant Field Values
  - OVAL
```
public static final int OVAL
```
    See Also:
    
    Constant Field Values
  - POLYGON
```
public static final int POLYGON
```
    See Also:
    
    Constant Field Values
  - FREEROI
```
public static final int FREEROI
```
    See Also:
    
    Constant Field Values
  - TRACED_ROI
```
public static final int TRACED_ROI
```
    See Also:
    
    Constant Field Values
  - LINE
```
public static final int LINE
```
    See Also:
    
    Constant Field Values
  - POLYLINE
```
public static final int POLYLINE
```
    See Also:
    
    Constant Field Values
  - FREELINE
```
public static final int FREELINE
```
    See Also:
    
    Constant Field Values
  - ANGLE
```
public static final int ANGLE
```
    See Also:
    
    Constant Field Values
  - COMPOSITE
```
public static final int COMPOSITE
```
    See Also:
    
    Constant Field Values
  - POINT
```
public static final int POINT
```
    See Also:
    
    Constant Field Values
  - HANDLE_SIZE
```
public static final int HANDLE_SIZE
```
    See Also:
    
    Constant Field Values
  - NOT_PASTING
```
public static final int NOT_PASTING
```
    See Also:
    
    Constant Field Values
  - previousRoi
```
public static Roi previousRoi
```
  - onePixelWide
```
public static final BasicStroke onePixelWide
```
  - lineWidth
```
protected static int lineWidth
```
  - defaultFillColor
```
protected static Color defaultFillColor
```
  - ROIColor
```
protected static Color ROIColor
```
  - type
```
protected int type
```
  - xMax
```
protected int xMax
```
  - yMax
```
protected int yMax
```
  - oldX
```
protected int oldX
```
  - oldY
```
protected int oldY
```
  - oldWidth
```
protected int oldWidth
```
  - oldHeight
```
protected int oldHeight
```
  - clipX
```
protected int clipX
```
  - clipY
```
protected int clipY
```
  - clipWidth
```
protected int clipWidth
```
  - clipHeight
```
protected int clipHeight
```
  - constrain
```
protected boolean constrain
```
  - center
```
protected boolean center
```
  - aspect
```
protected boolean aspect
```
  - updateFullWindow
```
protected boolean updateFullWindow
```
  - mag
```
protected double mag
```
  - asp_bk
```
protected double asp_bk
```
  - handleColor
```
protected Color handleColor
```
  - strokeColor
```
protected Color strokeColor
```
  - instanceColor
```
protected Color instanceColor
```
  - fillColor
```
protected Color fillColor
```
  - stroke
```
protected BasicStroke stroke
```
  - nonScalable
```
protected boolean nonScalable
```
  - overlay
```
protected boolean overlay
```
  - wideLine
```
protected boolean wideLine
```
  - ignoreClipRect
```
protected boolean ignoreClipRect
```
- Constructor Detail
  - Roi
```
public Roi(int x,
           int y,
           int width,
           int height)
```
    Creates a rectangular ROI.
  - Roi
```
public Roi(double x,
           double y,
           double width,
           double height)
```
    Creates a rectangular ROI using double arguments.
  - Roi
```
public Roi(int x,
           int y,
           int width,
           int height,
           int cornerDiameter)
```
    Creates a new rounded rectangular ROI.
  - Roi
```
public Roi(double x,
           double y,
           double width,
           double height,
           int cornerDiameter)
```
    Creates a rounded rectangular ROI using double arguments.
  - Roi
```
public Roi(Rectangle r)
```
    Creates a new rectangular Roi.
- Method Detail
  - setLocation
```
public void setLocation(int x,
                        int y)
```
    Set the location of the ROI in image coordinates.
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    Set the location of the ROI in image coordinates.
  - getType
```
public int getType()
```
  - getState
```
public int getState()
```
  - getConvexHull
```
public Polygon getConvexHull()
```
  - getBounds
```
public Rectangle getBounds()
```
    Return this selection's bounding rectangle.
  - getFloatBounds
```
public Rectangle2D.Double getFloatBounds()
```
    Return this selection's bounding rectangle.
  - getBoundingRect
```
public Rectangle getBoundingRect()
```
    Deprecated. replaced by getBounds()
  - getPolygon
```
public Polygon getPolygon()
```
    Returns the outline of this selection as a Polygon, or null if this is a straight line selection.
  - clipRectMargin
```
protected int clipRectMargin()
```
  - draw
```
public void draw(Graphics g)
```
  - drawOverlay
```
public void drawOverlay(Graphics g)
```
  - setColor
```
public static void setColor(Color c)
```
    Sets the default (global) color used for ROI outlines.
    
    See Also:
    
    getColor(), setStrokeColor(Color)
  - getColor
```
public static Color getColor()
```
    Returns the default (global) color used for drawing ROI outlines.
    
    See Also:
    
    setColor(Color), getStrokeColor()
  - contains
```
public boolean contains(int x,
                        int y)
```
  - setStrokeColor
```
public void setStrokeColor(Color c)
```
    Sets the color used by this ROI to draw its outline. This color, if not null, overrides the global color set by the static setColor() method.
    
    See Also:
    
    getStrokeColor(), setStrokeWidth(float)
  - getStrokeColor
```
public Color getStrokeColor()
```
    Returns the the color used to draw the ROI outline or null if the default color is being used.
    
    See Also:
    
    setStrokeColor(Color)
  - setFillColor
```
public void setFillColor(Color color)
```
    Sets the fill color used to display this ROI, or set to null to display it transparently.
    
    See Also:
    
    getFillColor(), setStrokeColor(java.awt.Color)
  - getFillColor
```
public Color getFillColor()
```
    Returns the fill color used to display this ROI, or null if it is displayed transparently.
    
    See Also:
    
    setFillColor(java.awt.Color), getStrokeColor()
  - setDefaultFillColor
```
public static void setDefaultFillColor(Color color)
```
  - getDefaultFillColor
```
public static Color getDefaultFillColor()
```
  - copyAttributes
```
public void copyAttributes(Roi roi2)
```
    Copy the attributes (outline color, fill color, outline width) of 'roi2' to the this selection.
  - setNonScalable
```
public void setNonScalable(boolean nonScalable)
```
    Set 'nonScalable' true to have TextRois in a display list drawn at a fixed location and size.
  - setStrokeWidth
```
public void setStrokeWidth(float width)
```
    Sets the width of the line used to draw this ROI. Set the width to 0.0 and the ROI will be drawn using a a 1 pixel stroke width regardless of the magnification.
    
    See Also:
    
    setStrokeColor(Color)
  - setStrokeWidth
```
public void setStrokeWidth(double width)
```
    This is a version of setStrokeWidth() that accepts a double argument.
  - getStrokeWidth
```
public float getStrokeWidth()
```
    Returns the lineWidth.
  - setStroke
```
public void setStroke(BasicStroke stroke)
```
    Sets the Stroke used to draw this ROI.
  - getStroke
```
public BasicStroke getStroke()
```
    Returns the Stroke used to draw this ROI, or null if no Stroke is used.
  - getName
```
public String getName()
```
    Returns the name of this ROI, or null.
  - setName
```
public void setName(String name)
```
    Sets the name of this ROI.
  - setCornerDiameter
```
public void setCornerDiameter(int cornerDiameter)
```
    Sets the rounded rectangle corner diameter (pixels).
  - getCornerDiameter
```
public int getCornerDiameter()
```
    Returns the rounded rectangle corner diameter (pixels).
  - setRoundRectArcSize
```
public void setRoundRectArcSize(int cornerDiameter)
```
    Obsolete; replaced by setCornerDiameter().
  - getRoundRectArcSize
```
public int getRoundRectArcSize()
```
    Obsolete; replaced by getCornerDiameter().
  - setPosition
```
public void setPosition(int n)
```
    Sets the stack position (image number) of this ROI. In an overlay, this ROI is only displayed when the stack is at the specified position. Set to zero to have the ROI displayed on all images in the stack.
    
    See Also:
    
    Overlay
  - getPosition
```
public int getPosition()
```
    Returns the stack position (image number) of this ROI, or zero if the ROI is not associated with a particular stack image.
    
    See Also:
    
    Overlay
  - setPosition
```
public void setPosition(int channel,
                        int slice,
                        int frame)
```
    Sets the hyperstack position of this ROI. In an overlay, this ROI is only displayed when the hyperstack is at the specified position.
    
    See Also:
    
    Overlay
  - getCPosition
```
public final int getCPosition()
```
    Returns the channel position of this ROI, or zero if this ROI is not associated with a particular channel.
  - getZPosition
```
public final int getZPosition()
```
    Returns the slice position of this ROI, or zero if this ROI is not associated with a particular slice.
  - getTPosition
```
public final int getTPosition()
```
    Returns the frame position of this ROI, or zero if this ROI is not associated with a particular frame.
  - setPrototypeOverlay
```
public void setPrototypeOverlay(Overlay overlay)
```
  - getPrototypeOverlay
```
public Overlay getPrototypeOverlay()
```
  - isArea
```
public boolean isArea()
```
    Returns 'true' if this is an area selection.
  - isLine
```
public boolean isLine()
```
    Returns 'true' if this is a line selection.
  - isDrawingTool
```
public boolean isDrawingTool()
```
    Returns 'true' if this is an ROI primarily used from drawing (e.g., TextRoi or Arrow).
  - getTypeAsString
```
public String getTypeAsString()
```
    Convenience method that converts Roi type to a human-readable form.
  - subPixelResolution
```
public boolean subPixelResolution()
```
    Returns true if this is a slection that supports sub-pixel resolution.
  - getDrawOffset
```
public boolean getDrawOffset()
```
    Returns true if this is a PolygonRoi that supports sub-pixel resolution and polygons are drawn on zoomed images offset down and to the right by 0.5 pixels..
  - setDrawOffset
```
public void setDrawOffset(boolean drawOffset)
```
  - setIgnoreClipRect
```
public void setIgnoreClipRect(boolean ignoreClipRect)
```
  - toInt
```
public static int[] toInt(float[] arr)
```
    Converts a float array to an int array using truncation.
  - toInt
```
public static int[] toInt(float[] arr,
                          int[] arr2,
                          int size)
```
  - toIntR
```
public static int[] toIntR(float[] arr)
```
    Converts a float array to an int array using rounding.
  - toFloat
```
public static float[] toFloat(int[] arr)
```
    Converts an int array to a float array.
  - setProperty
```
public void setProperty(String key,
                        String value)
```
  - getProperty
```
public String getProperty(String property)
```
  - getProperties
```
public String getProperties()
```
  - getPropertyCount
```
public int getPropertyCount()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - temporarilyHide
```
public void temporarilyHide()
```
    Deprecated
  - getXBase
```
public double getXBase()
```
  - getYBase
```
public double getYBase()
```
  - getFloatWidth
```
public double getFloatWidth()
```
  - getFloatHeight
```
public double getFloatHeight()
```
  - getAngle
```
public double getAngle()
```
    Overridden by PolygonRoi (angle between first two points), TextRoi (text angle) and Line (line angle).
  - enableSubPixelResolution
```
public void enableSubPixelResolution()
```
  - setIsCursor
```
public void setIsCursor(boolean isCursor)
```
  - isCursor
```
public boolean isCursor()
```
  - getDebugInfo
```
public String getDebugInfo()
```
  - setRotationCenter
```
public void setRotationCenter(double x,
                              double y)
```
  - getHashCode
```
public int getHashCode()
```
    Returns a hashcode for this Roi that typically changes if it is moved, even though it is still the same object.

Class Roi

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONSTRUCTING

MOVING

RESIZING

NORMAL

MOVING_HANDLE

RECTANGLE

OVAL

POLYGON

FREEROI

TRACED_ROI

LINE

POLYLINE

FREELINE

ANGLE

COMPOSITE

POINT

HANDLE_SIZE

NOT_PASTING

previousRoi

onePixelWide

lineWidth

defaultFillColor

ROIColor

type

xMax

yMax

oldX

oldY

oldWidth

oldHeight

clipX

clipY

clipWidth

clipHeight

constrain

center

aspect

updateFullWindow

mag

asp_bk

handleColor

strokeColor

instanceColor

fillColor

stroke

nonScalable

overlay

wideLine

ignoreClipRect

Constructor Detail

Roi

Roi

Roi

Roi

Roi

Method Detail

setLocation

setLocation

getType

getState

getConvexHull

getBounds

getFloatBounds

getBoundingRect

getPolygon

clipRectMargin

draw

drawOverlay

setColor

getColor

contains

setStrokeColor

getStrokeColor

setFillColor