java.lang.Object

ij.gui.Roi

ij.gui.Line

All Implemented Interfaces:: Serializable, Cloneable, Iterable<Point>

Direct Known Subclasses:: Arrow

public class Line
extends Roi

This class represents a straight line selection.

See Also:: Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class Line.PointIterator
Dedicated point iterator for thin lines.

Field Summary

Fields
Modifier and Type	Field	Description
`protected double`	`startxd`
`protected double`	`startyd`
`int`	`x1`
`double`	`x1d`
`protected double`	`x1R`
`int`	`x2`
`double`	`x2d`
`protected double`	`x2R`
`int`	`y1`
`double`	`y1d`
`protected double`	`y1R`
`int`	`y2`
`double`	`y2d`
`protected double`	`y2R`

Fields inherited from class ij.gui.Roi

ANGLE, asp_bk, aspect, cachedMask, center, clipboard, clipHeight, clipWidth, clipX, clipY, COMPOSITE, constrain, CONSTRUCTING, defaultFillColor, FERET_ARRAY_POINTOFFSET, FERET_ARRAYSIZE, 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, type, updateFullWindow, wideLine, xMax, yMax

Constructor Summary

Constructors
Constructor	Description
`Line(double ox1, double oy1, double ox2, double oy2)`	Creates a new straight line selection using the specified starting and ending offscreen double coordinates.
`Line(int ox1, int oy1, int ox2, int oy2)`	Creates a new straight line selection using the specified starting and ending offscreen integer coordinates.
`Line(int ox1, int oy1, int ox2, int oy2, ImagePlus imp)`	Deprecated. replaced by Line(int, int, int, int)
`Line(int sx, int sy, ImagePlus imp)`	Starts the process of creating a new user-generated straight line selection.

Method Summary

Modifier and Type	Method	Description
`protected int`	`clipRectMargin()`
`boolean`	`contains(int x, int y)`	Returns whether the center of pixel (x,y) is contained in the Roi.
`void`	`draw(Graphics g)`	Draws this line on the image.
`protected void`	`drawLine(int sx, int sy)`
`void`	`drawPixels(ImageProcessor ip)`	Draws the selection outline on the specified ImageProcessor.
`double`	`getAngle()`	Overridden by PolygonRoi (angle between first two points), TextRoi (text angle) and Line (line angle).
`Rectangle`	`getBounds()`	Return the bounding rectangle of this line.
`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..
`FloatPolygon`	`getFloatPoints()`	Returns, as a FloatPolygon, the two points that define this line.
`FloatPolygon`	`getFloatPolygon()`	If the width of this line is less than or equal to one, returns the starting and ending coordinates as a 2-point FloatPolygon, or, if the width is greater than one, returns an outline of the line as a 4-point FloatPolygon.
`double`	`getLength()`	Returns the length of this line.
`double[]`	`getPixels()`	Returns the pixel values along this line.
`Polygon`	`getPoints()`	Returns, as a Polygon, the two points that define this line.
`Polygon`	`getPolygon()`	If the width of this line is less than or equal to one, returns the starting and ending coordinates as a 2-point Polygon, or, if the width is greater than one, returns an outline of the line as a 4-point Polygon.
`double`	`getRawLength()`	Returns the length of this line in pixels.
`FloatPolygon`	`getRotationCenter()`
`static int`	`getWidth()`
`protected void`	`grow(int sx, int sy)`
`protected void`	`handleMouseDown(int sx, int sy)`
`protected void`	`handleMouseUp(int screenX, int screenY)`
`int`	`isHandle(int sx, int sy)`	Returns a handle number if the specified screen coordinates are inside or near a handle, otherwise returns -1.
`Iterator<Point>`	`iterator()`	Required by the `Iterable` interface.
`protected void`	`mouseDownInHandle(int handle, int sx, int sy)`
`void`	`mouseMoved(MouseEvent e)`
`protected void`	`moveHandle(int sx, int sy)`
`void`	`nudgeCorner(int key)`	Nudge end point of line by one pixel.
`void`	`setDrawOffset(boolean drawOffset)`
`void`	`setLocation(int x, int y)`	Set the location of the ROI in image coordinates.
`void`	`setStrokeWidth(float width)`	Sets the width of the line used to draw this ROI.
`static void`	`setWidth(int w)`
`void`	`showStatus()`
`int`	`size()`	Returns the number of points in this selection; equivalent to getPolygon().npoints.
`boolean`	`subPixelResolution()`	Always returns true.

Methods inherited from class ij.gui.Roi

abortModification, abortPaste, addRoiListener, clone, containsPoint, convertToPolygon, copyAttributes, drawOverlay, drawPixels, enableSubPixelResolution, endPaste, equals, getAngle, getAntiAlias, getBoundingRect, getColor, getContainedFloatPoints, getContainedPoints, getContourCentroid, getConvexHull, getCornerDiameter, getCPosition, getCurrentPasteMode, getDebugInfo, getDefaultFillColor, getFeretsDiameter, getFeretValues, getFillColor, getFloatAngle, getFloatBounds, getFloatConvexHull, getFloatHeight, getFloatPolygon, getFloatWidth, getHashCode, getImage, getImageID, getInterpolatedPolygon, getInterpolatedPolygon, getInterpolatedPolygon, getInverse, getMagnification, getMask, getName, getPasteMode, getPosition, getProperties, getProperty, getPropertyCount, getPrototypeOverlay, getRoundRectArcSize, getScaledStroke, getState, getStatistics, getStroke, getStrokeColor, getStrokeWidth, getTPosition, getType, getTypeAsString, getXBase, getYBase, getZPosition, handleMouseDrag, hasHyperStackPosition, isActiveOverlayRoi, isArea, isCursor, isDrawingTool, isInteger, isLine, isVisible, lineCircleIntersection, mouseDragged, mouseReleased, notifyListeners, nudge, removeRoiListener, screenX, screenXD, screenY, screenYD, setAntiAlias, setColor, setCornerDiameter, setDefaultFillColor, setFillColor, setFlattenScale, setIgnoreClipRect, setImage, setInstanceColor, setIsCursor, setLineWidth, setLocation, setName, setNonScalable, setPasteMode, setPosition, setPosition, setPosition, setProperties, setProperty, setPrototypeOverlay, setRenderingHint, setRotationCenter, setRoundRectArcSize, setStroke, setStrokeColor, setStrokeWidth, startPaste, temporarilyHide, toFloat, toInt, toInt, toIntR, toString, update, updateClipRect, updateWideLine

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details
- x1
  
  public int x1
- y1
  
  public int y1
- x2
  
  public int x2
- y2
  
  public int y2
- x1d
  
  public double x1d
- y1d
  
  public double y1d
- x2d
  
  public double x2d
- y2d
  
  public double y2d
- x1R
  
  protected double x1R
- y1R
  
  protected double y1R
- x2R
  
  protected double x2R
- y2R
  
  protected double y2R
- startxd
  
  protected double startxd
- startyd
  
  protected double startyd
Constructor Details
- Line
  
  public Line(int ox1, int oy1, int ox2, int oy2)
  
  Creates a new straight line selection using the specified starting and ending offscreen integer coordinates.
- Line
  
  public Line(double ox1, double oy1, double ox2, double oy2)
  
  Creates a new straight line selection using the specified starting and ending offscreen double coordinates.
- Line
  
  public Line(int sx, int sy, ImagePlus imp)
  
  Starts the process of creating a new user-generated straight line selection. 'sx' and 'sy' are screen coordinates that specify the start of the line. The user will determine the end of the line interactively using rubber banding.
- Line
  
  public Line(int ox1, int oy1, int ox2, int oy2, ImagePlus imp)
  
  Deprecated.
  replaced by Line(int, int, int, int)
Method Details
- grow
  
  protected void grow(int sx, int sy)
  
  Overrides:
  
  grow in class Roi
- mouseMoved
  
  public void mouseMoved(MouseEvent e)
  
  Overrides:
  
  mouseMoved in class Roi
- handleMouseUp
  
  protected void handleMouseUp(int screenX, int screenY)
  
  Overrides:
  
  handleMouseUp in class Roi
- drawLine
  
  protected void drawLine(int sx, int sy)
- moveHandle
  
  protected void moveHandle(int sx, int sy)
  
  Overrides:
  
  moveHandle in class Roi
- mouseDownInHandle
  
  protected void mouseDownInHandle(int handle, int sx, int sy)
  
  Overrides:
  
  mouseDownInHandle in class Roi
- draw
  
  public void draw(Graphics g)
  
  Draws this line on the image.
  
  Overrides:
  
  draw in class Roi
- showStatus
  
  public void showStatus()
  
  Overrides:
  
  showStatus in class Roi
- getAngle
  
  public double getAngle()
  
  Description copied from class: Roi
  
  Overridden by PolygonRoi (angle between first two points), TextRoi (text angle) and Line (line angle).
  
  Overrides:
  
  getAngle in class Roi
- getLength
  
  public double getLength()
  
  Returns the length of this line.
  
  Overrides:
  
  getLength in class Roi
- getRawLength
  
  public double getRawLength()
  
  Returns the length of this line in pixels.
- getPixels
  
  public double[] getPixels()
  
  Returns the pixel values along this line.
- getPoints
  
  public Polygon getPoints()
  
  Returns, as a Polygon, the two points that define this line.
- getFloatPoints
  
  public FloatPolygon getFloatPoints()
  
  Returns, as a FloatPolygon, the two points that define this line.
- getPolygon
  
  public Polygon getPolygon()
  
  If the width of this line is less than or equal to one, returns the starting and ending coordinates as a 2-point Polygon, or, if the width is greater than one, returns an outline of the line as a 4-point Polygon.
  
  Overrides:
  
  getPolygon in class Roi
  
  See Also:
  
  getFloatPolygon(), getPoints()
- getFloatPolygon
  
  public FloatPolygon getFloatPolygon()
  
  If the width of this line is less than or equal to one, returns the starting and ending coordinates as a 2-point FloatPolygon, or, if the width is greater than one, returns an outline of the line as a 4-point FloatPolygon.
  
  Overrides:
  
  getFloatPolygon in class Roi
  
  See Also:
  
  getFloatPoints()
- size
  
  public int size()
  
  Returns the number of points in this selection; equivalent to getPolygon().npoints.
  
  Overrides:
  
  size in class Roi
- drawPixels
  
  public void drawPixels(ImageProcessor ip)
  
  Description copied from class: Roi
  
  Draws the selection outline on the specified ImageProcessor.
  
  Overrides:
  
  drawPixels in class Roi
  
  See Also:
  
  ImageProcessor.setColor(java.awt.Color), ImageProcessor.setLineWidth(int)
- contains
  
  public boolean contains(int x, int y)
  
  Description copied from class: Roi
  
  Returns whether the center of pixel (x,y) is contained in the Roi. The position of a pixel center determines whether a pixel is selected. Points exactly at the left (right) border are considered outside (inside); points exactly on horizontal borders are considered outside (inside) at the border with the lower (higher) y. This convention is opposite to that of the java.awt.Shape class.
  
  Overrides:
  
  contains in class Roi
- handleMouseDown
  
  protected void handleMouseDown(int sx, int sy)
  
  Overrides:
  
  handleMouseDown in class Roi
- isHandle
  
  public int isHandle(int sx, int sy)
  
  Returns a handle number if the specified screen coordinates are inside or near a handle, otherwise returns -1.
  
  Overrides:
  
  isHandle in class Roi
- getWidth
  
  public static int getWidth()
- setWidth
  
  public static void setWidth(int w)
- setStrokeWidth
  
  public void setStrokeWidth(float width)
  
  Description copied from class: Roi
  
  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.
  
  Overrides:
  
  setStrokeWidth in class Roi
  
  See Also:
  
  Roi.setStrokeColor(Color), ImagePlus.setOverlay(ij.gui.Overlay)
- getBounds
  
  public Rectangle getBounds()
  
  Return the bounding rectangle of this line.
  
  Overrides:
  
  getBounds in class Roi
- clipRectMargin
  
  protected int clipRectMargin()
  
  Overrides:
  
  clipRectMargin in class Roi
- nudgeCorner
  
  public void nudgeCorner(int key)
  
  Nudge end point of line by one pixel.
  
  Overrides:
  
  nudgeCorner in class Roi
- getDrawOffset
  
  public boolean getDrawOffset()
  
  Description copied from class: Roi
  
  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..
  
  Overrides:
  
  getDrawOffset in class Roi
- setDrawOffset
  
  public void setDrawOffset(boolean drawOffset)
  
  Overrides:
  
  setDrawOffset in class Roi
- subPixelResolution
  
  public boolean subPixelResolution()
  
  Always returns true.
  
  Overrides:
  
  subPixelResolution in class Roi
- setLocation
  
  public void setLocation(int x, int y)
  
  Description copied from class: Roi
  
  Set the location of the ROI in image coordinates.
  
  Overrides:
  
  setLocation in class Roi
- getRotationCenter
  
  public FloatPolygon getRotationCenter()
  
  Overrides:
  
  getRotationCenter in class Roi
- iterator
  
  public Iterator<Point> iterator()
  
  Description copied from class: Roi
  Required by the Iterable interface. Use to iterate over the contained coordinates. Usage example:
  for (Point p : roi) { // process p }
  Author: Wilhelm Burger
  Specified by:
  
  iterator in interface Iterable<Point>
  
  Overrides:
  
  iterator in class Roi
  
  See Also:
  
  Roi.getContainedPoints(), Roi.getContainedFloatPoints()

Class Line

Nested Class Summary

Field Summary

Fields inherited from class ij.gui.Roi

Constructor Summary

Method Summary

Methods inherited from class ij.gui.Roi

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Details

Constructor Details

Method Details