PolygonRegionOfInterest (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.AbstractRegionOfInterest
- - net.imglib2.roi.AbstractIterableRegionOfInterest
  - - net.imglib2.roi.PolygonRegionOfInterest

All Implemented Interfaces:

EuclideanSpace, RealInterval, RealRandomAccessible<BitType>, RealRandomAccessibleRealInterval<BitType>, IterableRegionOfInterest, RegionOfInterest

Deprecated.
```
@Deprecated
public class PolygonRegionOfInterest
extends AbstractIterableRegionOfInterest
```
TODO

Author:

Lee Kamentsky

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`PolygonRegionOfInterest.Stripe` Deprecated. We decompose the polygon into stripes from yMin to yMin which have arrays of xTop and xBottom describing the polygon boundary between yMin and yMax.

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest
AbstractIterableRegionOfInterest.AROIClippedIterableInterval<T extends Type<T>>, AbstractIterableRegionOfInterest.AROIIterableInterval<T extends Type<T>>, AbstractIterableRegionOfInterest.AROIIterationOrder

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractRegionOfInterest
AbstractRegionOfInterest.AROIRandomAccess

Field Summary

Fields
Modifier and Type Field and Description

protected ArrayList<RealPoint> points
Deprecated.
- Fields inherited from class net.imglib2.roi.AbstractRegionOfInterest
  nDimensions

Fields
Modifier and Type	Field and Description
`protected ArrayList<RealPoint>`	`points` Deprecated.

Constructor Summary

Constructors
Constructor and Description

PolygonRegionOfInterest()
Deprecated.

Constructors
Constructor and Description
`PolygonRegionOfInterest()` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addVertex(int index, RealLocalizable p)` Deprecated. Insert a point into the polygon at the given index
`boolean`	`contains(double[] position)` Deprecated. Determine whether a point is a member of the region of interest
`protected int`	`findStripeIndex(double y)` Deprecated. Find the index of the stripe whose yMin is lower or the same as the given y
`RealLocalizable`	`getEdgeEnd(int start)` Deprecated. Get the coordinates of the second vertex of the indexed edge
`protected boolean`	`getEdges(double[] position, double[] x_intercepts)` Deprecated. Get the closest edge to the left of this one
`RealLocalizable`	`getEdgeStart(int start)` Deprecated. Get the coordinates of the first vertex of the indexed edge
`protected void`	`getExtrema(long[] minima, long[] maxima)` Deprecated. Get the minimum and maximum corners of a bounding hypercube around all points in the ROI.
`protected void`	`getRealExtrema(double[] minima, double[] maxima)` Deprecated. Get the minimum and maximum corners of a bounding hypercube using real coordinates (which might have fractional components) The implementer should only override this if the ROI is described in real coordinates.
`RealLocalizable`	`getVertex(int index)` Deprecated. Get a vertex by index
`int`	`getVertexCount()` Deprecated.
`double`	`interpolateEdgeXAtY(int start, double y)` Deprecated. Given an edge and a Y coordinate, find its X coordinate at that Y coordinate.
`boolean`	`isHorizontal(int index)` Deprecated. Determine whether the given edge is horizontal.
`void`	`move(double displacement, int d)` Deprecated.
`protected boolean`	`nextRaster(long[] position, long[] end)` Deprecated. Advance the position to the next raster.
`void`	`removeVertex(int index)` Deprecated. Remove a vertex from the polygon
`void`	`setVertexPosition(int index, double[] position)` Deprecated. Change the position of a vertex
`void`	`setVertexPosition(int index, float[] position)` Deprecated. Change the position of a vertex
`void`	`setVertexPosition(int index, RealLocalizable localizable)` Deprecated. Change the position of a vertex using a localizable
`String`	`toString()` Deprecated.
`protected void`	`validate()` Deprecated. Build the cached list of stripes if necessary.

Methods inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest
dimension, dimensions, getCachedSize, getIterableIntervalOverROI, invalidateCachedState, jumpFwd, max, max, max, min, min, min, nextRaster, remove, size

Methods inherited from class net.imglib2.roi.AbstractRegionOfInterest
move, numDimensions, realMax, realMax, realMax, realMin, realMin, realMin, realRandomAccess, realRandomAccess, validateRealExtremaCache

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

Methods inherited from interface net.imglib2.roi.RegionOfInterest
move

Methods inherited from interface net.imglib2.RealRandomAccessible
getAt, getAt, getAt, realRandomAccess, realRandomAccess

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Field Detail
  - points
```
protected ArrayList<RealPoint> points
```
    Deprecated.
- Constructor Detail
  - PolygonRegionOfInterest
```
public PolygonRegionOfInterest()
```
    Deprecated.
- Method Detail
  - getVertexCount
```
public int getVertexCount()
```
    Deprecated.
    
    Returns:
    
    the number of vertices in the polygon which is equal to the number of edges.
  - getVertex
```
public RealLocalizable getVertex(int index)
```
    Deprecated.
    
    Get a vertex by index
    
    Parameters:
    
    index - index of the vertex to get
    
    Returns:
    
    the vertex
  - addVertex
```
public void addVertex(int index,
                      RealLocalizable p)
```
    Deprecated.
    
    Insert a point into the polygon at the given index
    
    Parameters:
    
    p - point to be inserted
    
    index - index of point.
  - removeVertex
```
public void removeVertex(int index)
```
    Deprecated.
    
    Remove a vertex from the polygon
    
    Parameters:
    
    index - index of the vertex to remove
  - setVertexPosition
```
public void setVertexPosition(int index,
                              double[] position)
```
    Deprecated.
    
    Change the position of a vertex
    
    Parameters:
    
    index - index of the vertex in question
    
    position -
  - setVertexPosition
```
public void setVertexPosition(int index,
                              float[] position)
```
    Deprecated.
    
    Change the position of a vertex
    
    Parameters:
    
    index - index of the vertex in question
    
    position -
  - setVertexPosition
```
public void setVertexPosition(int index,
                              RealLocalizable localizable)
```
    Deprecated.
    
    Change the position of a vertex using a localizable
    
    Parameters:
    
    index - index of the vertex in question
    
    localizable - containing the new position
  - validate
```
protected void validate()
```
    Deprecated.
    
    Build the cached list of stripes if necessary.
  - findStripeIndex
```
protected int findStripeIndex(double y)
```
    Deprecated.
    
    Find the index of the stripe whose yMin is lower or the same as the given y
    
    Parameters:
    
    y -
    
    Returns:
    
    the index or -1 if all are greater. Pseudocode borrowed from http://en.wikipedia.org/wiki/Binary_search_algorithm
  - getRealExtrema
```
protected void getRealExtrema(double[] minima,
                              double[] maxima)
```
    Deprecated.
    
    Description copied from class: AbstractIterableRegionOfInterest
    
    Get the minimum and maximum corners of a bounding hypercube using real coordinates (which might have fractional components) The implementer should only override this if the ROI is described in real coordinates. Otherwise, the pixel extrema are used.
    
    Overrides:
    
    getRealExtrema in class AbstractIterableRegionOfInterest
  - getExtrema
```
protected void getExtrema(long[] minima,
                          long[] maxima)
```
    Deprecated.
    
    Description copied from class: AbstractIterableRegionOfInterest
    
    Get the minimum and maximum corners of a bounding hypercube around all points in the ROI. The implementer should strongly consider implementing this to provide a more efficient implementation.
    
    Overrides:
    
    getExtrema in class AbstractIterableRegionOfInterest
    
    Parameters:
    
    minima - - minimum coordinates of the ROI
    
    maxima - - maximum coordinates of the ROI
  - nextRaster
```
protected boolean nextRaster(long[] position,
                             long[] end)
```
    Deprecated.
    
    Description copied from class: AbstractIterableRegionOfInterest
    
    Advance the position to the next raster. The AbstractRegionOfInterest successively adds one to the lowest dimension of the position until the position is outside the ROI as determined by isMember. At this point, it calls nextRaster to find the start of the next raster. As an example, a rectangle might have x, y, width and height. The code would determine if the y position was before, within or after the rectangle bounds. If before, set position[0] = x, position[1] = y and return true, if within, set position[0] = x, position[1] += 1, if after, return false.
    
    Specified by:
    
    nextRaster in class AbstractIterableRegionOfInterest
    
    Parameters:
    
    position - on entry, the position of the raster after advancement to its end (or initial or final position)
    
    end - on exit, the coordinates of the end of the raster. Index 0 is generally the only pertinent variable, subsequent indices should be duplicates of the start raster. Nevertheless, using an array lets the caller pass the results as a modification of the array.
    
    Returns:
    
    true if there is a raster after this one.
  - contains
```
public boolean contains(double[] position)
```
    Deprecated.
    
    Description copied from interface: RegionOfInterest
    
    Determine whether a point is a member of the region of interest
    
    Parameters:
    
    position - position in question
    
    Returns:
    
    true if a member
  - getEdgeStart
```
public RealLocalizable getEdgeStart(int start)
```
    Deprecated.
    
    Get the coordinates of the first vertex of the indexed edge
    
    Parameters:
    
    start - the index of the edge
    
    Returns:
    
    the first vertex, going clockwise
  - getEdgeEnd
```
public RealLocalizable getEdgeEnd(int start)
```
    Deprecated.
    
    Get the coordinates of the second vertex of the indexed edge
    
    Parameters:
    
    start - the index of the edge
    
    Returns:
    
    the second vertex, going clockwise
  - isHorizontal
```
public boolean isHorizontal(int index)
```
    Deprecated.
    
    Determine whether the given edge is horizontal. If so, interpolateEdgeXAtY won't work because the X is then indeterminate.
    
    Parameters:
    
    index - index of edge to examine
    
    Returns:
    
    true if horizontal (Y coordinates of start and end are identical)
  - interpolateEdgeXAtY
```
public double interpolateEdgeXAtY(int start,
                                  double y)
```
    Deprecated.
    
    Given an edge and a Y coordinate, find its X coordinate at that Y coordinate. NOTE: this assumes that isHorizontal(start) is false, else the X coordinate is indeterminate.
    
    Parameters:
    
    start - index of the edge
    
    Returns:
    
    the X coordinate
  - getEdges
```
protected boolean getEdges(double[] position,
                           double[] x_intercepts)
```
    Deprecated.
    
    Get the closest edge to the left of this one
    
    Parameters:
    
    position - position of interest
    
    x_intercepts - x-intercepts of the edges at the Y position passed in
    
    Returns:
    
    true if point is within polygon.
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object
  - move
```
public void move(double displacement,
                 int d)
```
    Deprecated.

Class PolygonRegionOfInterest

Nested Class Summary

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractRegionOfInterest

Field Summary

Fields inherited from class net.imglib2.roi.AbstractRegionOfInterest

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest

Methods inherited from class net.imglib2.roi.AbstractRegionOfInterest

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.roi.RegionOfInterest

Methods inherited from interface net.imglib2.RealRandomAccessible

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.EuclideanSpace

Field Detail

points

Constructor Detail

PolygonRegionOfInterest

Method Detail

getVertexCount

getVertex

addVertex

removeVertex

setVertexPosition

setVertexPosition

setVertexPosition

validate

findStripeIndex

getRealExtrema

getExtrema

nextRaster

contains

getEdgeStart

getEdgeEnd

isHorizontal

interpolateEdgeXAtY

getEdges

toString

move