PointRoi (ImageJ API)

java.lang.Object
- ij.gui.Roi
- - ij.gui.PolygonRoi
  - - ij.gui.PointRoi

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Point>
```
public class PointRoi
extends PolygonRoi
```
This class represents a collection of points.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static int MAX_COUNTERS

static String[] sizes

static String[] types
- Fields inherited from class ij.gui.PolygonRoi
  maxPoints, nPoints, splinePoints, xp, xp2, xpf, xSpline, yp, yp2, ypf, ySpline
- Fields inherited from class ij.gui.Roi
  ANGLE, asp_bk, aspect, cachedMask, center, clipboard, clipHeight, clipWidth, clipX, clipY, COMPOSITE, constrain, CONSTRUCTING, defaultFillColor, fillColor, flattenScale, FREELINE, FREEROI, HANDLE_SIZE, handleColor, ic, ignoreClipRect, imp, instanceColor, LINE, lineWidth, mag, MOVING, MOVING_HANDLE, nonScalable, NORMAL, NOT_PASTING, oldHeight, oldWidth, oldX, oldY, onePixelWide, OVAL, overlay, pasteMode, POINT, POLYGON, POLYLINE, previousRoi, RECTANGLE, RESIZING, ROIColor, stroke, strokeColor, TRACED_ROI, updateFullWindow, wideLine, xMax, yMax

Fields
Modifier and Type	Field	Description
`static int`	`MAX_COUNTERS`
`static String[]`	`sizes`
`static String[]`	`types`

Constructor Summary

Constructors
Constructor	Description
`PointRoi()`
`PointRoi(double ox, double oy)`	Creates a new PointRoi using the specified offscreen double coordinates.
`PointRoi(float[] ox, float[] oy)`	Creates a new PointRoi using the specified float arrays of offscreen coordinates.
`PointRoi(float[] ox, float[] oy, int points)`	Creates a new PointRoi using the specified float arrays of offscreen coordinates.
`PointRoi(int[] ox, int[] oy, int points)`	Creates a new PointRoi using the specified int arrays of offscreen coordinates.
`PointRoi(int ox, int oy)`	Creates a new PointRoi using the specified offscreen int coordinates.
`PointRoi(int sx, int sy, ImagePlus imp)`	Creates a new PointRoi using the specified screen coordinates.
`PointRoi(FloatPolygon poly)`	Creates a new PointRoi from a FloatPolygon.
`PointRoi(Polygon poly)`	Creates a new PointRoi from a Polygon.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`PointRoi`	`addPoint(double x, double y)`	Adds a point to this PointRoi.
`void`	`addPoint(ImagePlus imp, double ox, double oy)`	Adds a point to this PointRoi.
`void`	`addUserPoint(ImagePlus imp, double ox, double oy)`
`Object`	`clone()`	Returns a copy of this PointRoi.
`boolean`	`contains(int x, int y)`	Returns true if (x,y) is one of the points in this collection.
`protected void`	`deletePoint(int index)`
`void`	`displayCounts()`
`void`	`draw(Graphics g)`	Draws the points on the image.
`void`	`drawPixels(ImageProcessor ip)`	Draws the selection outline on the specified ImageProcessor.
`protected int`	`getClosestPoint(double x, double y, FloatPolygon points)`
`FloatPolygon`	`getContainedFloatPoints()`	Returns the points as a FloatPolygon.
`Point[]`	`getContainedPoints()`	Returns the points as an array of Points.
`int`	`getCount(int counter)`
`int`	`getCounter()`
`int`	`getCounter(int index)`	Returns the counter assocated with the specified point.
`static String[]`	`getCounterChoices()`
`int[]`	`getCounterInfo()`
`int[]`	`getCounters()`
`static Color`	`getDefaultCrossColor()`	Deprecated
`static String`	`getDefaultMarkerSize()`	Deprecated.
`static int`	`getDefaultSize()`
`static int`	`getDefaultType()`
`ImageProcessor`	`getMask()`	Always returns null for rectangular Roi's
`int`	`getNCounters()`
`int`	`getPointPosition(int index)`
`int`	`getPointType()`	Returns the point type (0=hybrid, 1=crosshair, 2=dot, 3=circle).
`boolean`	`getShowLabels()`
`int`	`getSize()`	Returns the point size (0-4).
`protected void`	`handleMouseUp(int sx, int sy)`	With segmented selections, ignore first mouse up and finalize when user double-clicks, control-clicks or clicks in start box.
`int`	`isHandle(int sx, int sy)`	Returns a point index if it has been at least one second since the last point was added and the specified screen coordinates are inside or near a point, otherwise returns -1.
`Iterator<Point>`	`iterator()`	Custom iterator for points contained in a `PointRoi`.
`boolean`	`promptBeforeDeleting()`
`void`	`promptBeforeDeleting(Boolean prompt)`
`void`	`resetCounters()`
`void`	`setCounter(int counter)`
`void`	`setCounterInfo(int[] info)`
`void`	`setCounters(int[] counters)`
`static void`	`setDefaultCounter(int counter)`
`static void`	`setDefaultCrossColor(Color color)`	Deprecated
`static void`	`setDefaultMarkerSize(String size)`	Deprecated.
`static void`	`setDefaultSize(int index)`
`static void`	`setDefaultType(int type)`
`void`	`setHideLabels(boolean hideLabels)`	Deprecated.
`void`	`setPointType(int type)`	Sets the point type (0=hybrid, 1=crosshair, 2=dot, 3=circle).
`void`	`setShowLabels(boolean showLabels)`
`void`	`setSize(int size)`	Sets the point size, where 'size' is 0-4.
`boolean`	`subPixelResolution()`	Always returns true.
`PointRoi`	`subtractPoints(Roi roi)`	Subtract the points that intersect the specified ROI and return the result.
`String`	`toString()`

Methods inherited from interface java.lang.Iterable
forEach, spliterator

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

Methods inherited from class ij.gui.Roi
abortPaste, addRoiListener, copyAttributes, drawOverlay, drawPixels, endPaste, equals, getAngle, getBoundingRect, getBounds, getColor, getContourCentroid, getCornerDiameter, getCPosition, getCurrentPasteMode, getDefaultFillColor, getFeretsDiameter, getFeretValues, getFillColor, getFloatAngle, getFloatBounds, getFloatHeight, getFloatWidth, getHashCode, getImage, getImageID, getInterpolatedPolygon, getInterpolatedPolygon, getMagnification, getName, getPasteMode, getPosition, getProperties, getProperty, getPropertyCount, getPrototypeOverlay, getRotationCenter, getRoundRectArcSize, getScaledStroke, getState, getStatistics, getStroke, getStrokeColor, getStrokeWidth, getTPosition, getType, getTypeAsString, getXBase, getYBase, getZPosition, handleMouseDown, handleMouseDrag, hasHyperStackPosition, isActiveOverlayRoi, isArea, isCursor, isDrawingTool, isLine, isVisible, lineCircleIntersection, mouseDragged, mouseReleased, notifyListeners, nudge, nudgeCorner, removeRoiListener, screenX, screenXD, screenY, screenYD, setColor, setCornerDiameter, setDefaultFillColor, setFillColor, setFlattenScale, setIgnoreClipRect, setImage, setInstanceColor, setIsCursor, setLineWidth, setLocation, setName, setNonScalable, setPasteMode, setPosition, setPosition, setPosition, setProperties, setProperty, setPrototypeOverlay, setRotationCenter, setRoundRectArcSize, setStroke, setStrokeColor, setStrokeWidth, setStrokeWidth, showStatus, startPaste, temporarilyHide, toFloat, toInt, toInt, toIntR, update, updateClipRect, updateWideLine

- Field Detail
  - sizes
```
public static final String[] sizes
```
  - types
```
public static final String[] types
```
  - MAX_COUNTERS
```
public static final int MAX_COUNTERS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PointRoi
```
public PointRoi()
```
  - PointRoi
```
public PointRoi(int[] ox,
                int[] oy,
                int points)
```
    Creates a new PointRoi using the specified int arrays of offscreen coordinates.
  - PointRoi
```
public PointRoi(float[] ox,
                float[] oy,
                int points)
```
    Creates a new PointRoi using the specified float arrays of offscreen coordinates.
  - PointRoi
```
public PointRoi(float[] ox,
                float[] oy)
```
    Creates a new PointRoi using the specified float arrays of offscreen coordinates.
  - PointRoi
```
public PointRoi(FloatPolygon poly)
```
    Creates a new PointRoi from a FloatPolygon.
  - PointRoi
```
public PointRoi(Polygon poly)
```
    Creates a new PointRoi from a Polygon.
  - PointRoi
```
public PointRoi(int ox,
                int oy)
```
    Creates a new PointRoi using the specified offscreen int coordinates.
  - PointRoi
```
public PointRoi(double ox,
                double oy)
```
    Creates a new PointRoi using the specified offscreen double coordinates.
  - PointRoi
```
public PointRoi(int sx,
                int sy,
                ImagePlus imp)
```
    Creates a new PointRoi using the specified screen coordinates.
- Method Detail
  - handleMouseUp
```
protected void handleMouseUp(int sx,
                             int sy)
```
    Description copied from class: PolygonRoi
    
    With segmented selections, ignore first mouse up and finalize when user double-clicks, control-clicks or clicks in start box.
    
    Overrides:
    
    handleMouseUp in class PolygonRoi
  - draw
```
public void draw(Graphics g)
```
    Draws the points on the image.
    
    Overrides:
    
    draw in class PolygonRoi
  - drawPixels
```
public void drawPixels(ImageProcessor ip)
```
    Description copied from class: Roi
    
    Draws the selection outline on the specified ImageProcessor.
    
    Overrides:
    
    drawPixels in class PolygonRoi
    
    See Also:
    
    ImageProcessor.setColor(java.awt.Color), ImageProcessor.setLineWidth(int)
  - addPoint
```
public void addPoint(ImagePlus imp,
                     double ox,
                     double oy)
```
    Adds a point to this PointRoi.
  - addUserPoint
```
public void addUserPoint(ImagePlus imp,
                         double ox,
                         double oy)
```
  - addPoint
```
public PointRoi addPoint(double x,
                         double y)
```
    Adds a point to this PointRoi.
  - deletePoint
```
protected void deletePoint(int index)
```
    Overrides:
    
    deletePoint in class PolygonRoi
  - resetCounters
```
public void resetCounters()
```
  - subtractPoints
```
public PointRoi subtractPoints(Roi roi)
```
    Subtract the points that intersect the specified ROI and return the result. Returns null if there are no resulting points.
  - getMask
```
public ImageProcessor getMask()
```
    Description copied from class: Roi
    
    Always returns null for rectangular Roi's
    
    Overrides:
    
    getMask in class PolygonRoi
  - contains
```
public boolean contains(int x,
                        int y)
```
    Returns true if (x,y) is one of the points in this collection.
    
    Overrides:
    
    contains in class PolygonRoi
  - setShowLabels
```
public void setShowLabels(boolean showLabels)
```
  - getShowLabels
```
public boolean getShowLabels()
```
  - setDefaultType
```
public static void setDefaultType(int type)
```
  - getDefaultType
```
public static int getDefaultType()
```
  - setPointType
```
public void setPointType(int type)
```
    Sets the point type (0=hybrid, 1=crosshair, 2=dot, 3=circle).
  - getPointType
```
public int getPointType()
```
    Returns the point type (0=hybrid, 1=crosshair, 2=dot, 3=circle).
  - setDefaultSize
```
public static void setDefaultSize(int index)
```
  - getDefaultSize
```
public static int getDefaultSize()
```
  - setSize
```
public void setSize(int size)
```
    Sets the point size, where 'size' is 0-4.
  - getSize
```
public int getSize()
```
    Returns the point size (0-4).
  - setDefaultCrossColor
```
public static void setDefaultCrossColor(Color color)
```
    Deprecated
  - getDefaultCrossColor
```
public static Color getDefaultCrossColor()
```
    Deprecated
  - subPixelResolution
```
public boolean subPixelResolution()
```
    Always returns true.
    
    Overrides:
    
    subPixelResolution in class PolygonRoi
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Roi
  - setCounter
```
public void setCounter(int counter)
```
  - getCounter
```
public int getCounter()
```
  - getNCounters
```
public int getNCounters()
```
  - promptBeforeDeleting
```
public boolean promptBeforeDeleting()
```
  - promptBeforeDeleting
```
public void promptBeforeDeleting(Boolean prompt)
```
  - setDefaultCounter
```
public static void setDefaultCounter(int counter)
```
  - getCount
```
public int getCount(int counter)
```
  - getCounter
```
public int getCounter(int index)
```
    Returns the counter assocated with the specified point.
  - getCounters
```
public int[] getCounters()
```
  - setCounters
```
public void setCounters(int[] counters)
```
  - getPointPosition
```
public int getPointPosition(int index)
```
  - displayCounts
```
public void displayCounts()
```
  - getCounterChoices
```
public static String[] getCounterChoices()
```
  - isHandle
```
public int isHandle(int sx,
                    int sy)
```
    Returns a point index if it has been at least one second since the last point was added and the specified screen coordinates are inside or near a point, otherwise returns -1.
    
    Overrides:
    
    isHandle in class PolygonRoi
  - getContainedPoints
```
public Point[] getContainedPoints()
```
    Returns the points as an array of Points. Wilhelm Burger: modified to use FloatPolygon for correct point positions.
    
    Overrides:
    
    getContainedPoints in class Roi
    
    See Also:
    
    Roi.getContainedFloatPoints(), Roi.iterator()
  - getContainedFloatPoints
```
public FloatPolygon getContainedFloatPoints()
```
    Returns the points as a FloatPolygon.
    
    Overrides:
    
    getContainedFloatPoints in class Roi
    
    See Also:
    
    Roi.getContainedPoints(), Roi.iterator()
  - iterator
```
public Iterator<Point> iterator()
```
    Custom iterator for points contained in a PointRoi. Author: W. Burger
    
    Specified by:
    
    iterator in interface Iterable<Point>
    
    Overrides:
    
    iterator in class Roi
    
    See Also:
    
    Roi.getContainedPoints(), Roi.getContainedFloatPoints()
  - getClosestPoint
```
protected int getClosestPoint(double x,
                              double y,
                              FloatPolygon points)
```
    Overrides:
    
    getClosestPoint in class PolygonRoi
  - clone
```
public Object clone()
```
    Returns a copy of this PointRoi.
    
    Overrides:
    
    clone in class PolygonRoi
  - setCounterInfo
```
public void setCounterInfo(int[] info)
```
  - getCounterInfo
```
public int[] getCounterInfo()
```
  - setHideLabels
```
public void setHideLabels(boolean hideLabels)
```
    Deprecated.
  - setDefaultMarkerSize
```
public static void setDefaultMarkerSize(String size)
```
    Deprecated.
  - getDefaultMarkerSize
```
public static String getDefaultMarkerSize()
```
    Deprecated.

Class PointRoi

Field Summary

Fields inherited from class ij.gui.PolygonRoi

Fields inherited from class ij.gui.Roi

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Methods inherited from class ij.gui.PolygonRoi

Methods inherited from class ij.gui.Roi

Field Detail

sizes

types

MAX_COUNTERS

Constructor Detail

PointRoi

PointRoi

PointRoi

PointRoi

PointRoi

PointRoi

PointRoi

PointRoi

PointRoi

Method Detail

handleMouseUp

draw

drawPixels

addPoint

addUserPoint

addPoint

deletePoint

resetCounters

subtractPoints

getMask

contains

setShowLabels

getShowLabels

setDefaultType

getDefaultType

setPointType

getPointType

setDefaultSize

getDefaultSize

setSize

getSize

setDefaultCrossColor

getDefaultCrossColor

subPixelResolution

toString

setCounter

getCounter

getNCounters

promptBeforeDeleting

promptBeforeDeleting

setDefaultCounter

getCount

getCounter

getCounters

setCounters

getPointPosition

displayCounts

getCounterChoices

isHandle

getContainedPoints

getContainedFloatPoints

iterator

getClosestPoint

clone

setCounterInfo

getCounterInfo

setHideLabels

setDefaultMarkerSize

getDefaultMarkerSize