ij.gui

Class PointRoi

java.lang.Object

ij.gui.Roi

ij.gui.PolygonRoi

ij.gui.PointRoi

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.awt.Point>

public class PointRoi
extends PolygonRoi

This class represents a collection of points.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_COUNTERS
static java.lang.String[]	sizes
static java.lang.String[]	types

Fields inherited from class ij.gui.Roi

ANGLE, COMPOSITE, CONSTRUCTING, FREELINE, FREEROI, HANDLE_SIZE, LINE, MOVING, MOVING_HANDLE, NORMAL, NOT_PASTING, onePixelWide, OVAL, POINT, POLYGON, POLYLINE, previousRoi, RECTANGLE, RESIZING, TRACED_ROI

Constructor Summary

Constructors

Constructor and Description
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(FloatPolygon poly) Creates a new PointRoi from a FloatPolygon.
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(java.awt.Polygon poly) Creates a new PointRoi from a Polygon.

Method Summary

Modifier and Type	Method and 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.
java.lang.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.
boolean	counting()
void	displayCounts()
void	draw(java.awt.Graphics g) Draws the points on the image.
void	drawPixels(ImageProcessor ip) Draws the selection outline on the specified ImageProcessor.
FloatPolygon	getContainedFloatPoints() Returns the points as a FloatPolygon.
java.awt.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 java.lang.String[]	getCounterChoices()
int[]	getCounterInfo()
int[]	getCounters()
static java.awt.Color	getDefaultCrossColor() Deprecated
static java.lang.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).
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.
java.util.Iterator<java.awt.Point>	iterator() Custom iterator for points contained in a PointRoi.
void	resetCounters()
void	setCounter(int counter)
void	setCounterInfo(int[] info)
void	setCounters(int[] counters)
static void	setDefaultCounter(int counter)
static void	setDefaultCrossColor(java.awt.Color color) Deprecated
static void	setDefaultMarkerSize(java.lang.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.
java.lang.String	toString()

Methods inherited from class ij.gui.PolygonRoi

deleteHandle, enableSubPixelResolution, exitConstructingMode, fitSpline, fitSpline, fitSplineForStraightening, getAngle, getConvexHull, getDebugInfo, getDrawOffset, getFloatPolygon, getInterpolatedPolygon, getLength, getNCoordinates, getNonSplineCoordinates, getNonSplineFloatPolygon, getPolygon, getUncalibratedLength, getXCoordinates, getYCoordinates, isSplineFit, mouseMoved, removeSplineFit, setDrawOffset, setLocation

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, getName, getPasteMode, getPosition, getProperties, getProperty, getPropertyCount, getPrototypeOverlay, getRotationCenter, getRoundRectArcSize, getState, getStatistics, getStroke, getStrokeColor, getStrokeWidth, getTPosition, getType, getTypeAsString, getXBase, getYBase, getZPosition, hasHyperStackPosition, isActiveOverlayRoi, isArea, isCursor, isDrawingTool, isLine, isVisible, lineCircleIntersection, mouseDragged, mouseReleased, notifyListeners, nudge, nudgeCorner, removeRoiListener, 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, startPaste, temporarilyHide, toFloat, toInt, toInt, toIntR, update, updateWideLine

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

sizes

public static final java.lang.String[] sizes

types

public static final java.lang.String[] types

MAX_COUNTERS

public static final int MAX_COUNTERS

See Also:

Constant Field Values

Constructor Detail

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(java.awt.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

draw

public void draw(java.awt.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.

addPoint

public PointRoi addPoint(double x,
                         double y)

Adds a point to this PointRoi.

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(java.awt.Color color)

Deprecated

getDefaultCrossColor

public static java.awt.Color getDefaultCrossColor()

Deprecated

subPixelResolution

public boolean subPixelResolution()

Always returns true.

Overrides:

subPixelResolution in class PolygonRoi

toString

public java.lang.String toString()

Overrides:

toString in class Roi

setCounter

public void setCounter(int counter)

getCounter

public int getCounter()

getNCounters

public int getNCounters()

counting

public boolean counting()

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 java.lang.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 java.awt.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 java.util.Iterator<java.awt.Point> iterator()

Custom iterator for points contained in a PointRoi. Author: W. Burger

Specified by:

iterator in interface java.lang.Iterable<java.awt.Point>

Overrides:

iterator in class Roi

See Also:

Roi.getContainedPoints(), Roi.getContainedFloatPoints()

clone

public java.lang.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(java.lang.String size)

Deprecated.

getDefaultMarkerSize

public static java.lang.String getDefaultMarkerSize()

Deprecated.