net.imglib2.roi.geom.real

Class DefaultWritablePolygon2D

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractRealInterval

net.imglib2.roi.geom.real.DefaultWritablePolygon2D

All Implemented Interfaces:

Predicate<RealLocalizable>, EuclideanSpace, RealInterval, Polygon2D, WritablePolygon2D, MaskPredicate<RealLocalizable>, RealMask, RealMaskRealInterval

Direct Known Subclasses:

ClosedWritablePolygon2D, OpenWritablePolygon2D

public class DefaultWritablePolygon2D
extends AbstractRealInterval
implements WritablePolygon2D

A DefaultWritablePolygon2D defined by the given vertices. The resulting polygon may contain some edge points, all edge points, or no edge points depending on the specified shape.

If consistent edge point inclusion/exclusion is needed see OpenWritablePolygon2D or ClosedWritablePolygon2D. These implementations will be less efficient but have consistent edge behavior.

Author:

Tobias Pietzsch, Daniel Seebacher, University of Konstanz, Christian Dietz, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
protected gnu.trove.list.array.TDoubleArrayList	x
protected gnu.trove.list.array.TDoubleArrayList	y

Fields inherited from class net.imglib2.AbstractRealInterval

max, min

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Constructor and Description
DefaultWritablePolygon2D(double[] x, double[] y) Creates a 2D polygon with vertices at the provided x, y coordinates.
DefaultWritablePolygon2D(List<? extends RealLocalizable> vertices) Creates a 2D polygon with the provided vertices.

Method Summary

Modifier and Type	Method and Description
void	addVertex(int index, double[] vertex) If the given vertex has more than 2 dimensions, the higher dimensions will be ignored.
boolean	equals(Object obj)
int	hashCode()
int	numVertices() Get the number of vertices
void	removeVertex(int index) Removes the vertex at the given index.
boolean	test(RealLocalizable localizable) Return true if the given point is contained inside the boundary.
RealLocalizableRealPositionable	vertex(int pos) Return a copy of the vertex

Methods inherited from class net.imglib2.AbstractRealInterval

realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class net.imglib2.AbstractEuclideanSpace

numDimensions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.roi.RealMaskRealInterval

and, isEmpty, minus, or, realMax, realMax, realMin, realMin, transform, xor

Methods inherited from interface net.imglib2.roi.RealMask

negate, or, transform, xor

Methods inherited from interface net.imglib2.roi.MaskPredicate

boundaryType, isAll, knownConstant

Methods inherited from interface java.util.function.Predicate

isEqual

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.RealInterval

realMax, realMin

Field Detail

x

protected final gnu.trove.list.array.TDoubleArrayList x

y

protected final gnu.trove.list.array.TDoubleArrayList y

Constructor Detail

DefaultWritablePolygon2D

public DefaultWritablePolygon2D(List<? extends RealLocalizable> vertices)

Creates a 2D polygon with the provided vertices.

Parameters:

vertices - List of vertices which will be copied. Each vertex should have a position in 2D space, positions beyond 2D will be ignored.

DefaultWritablePolygon2D

public DefaultWritablePolygon2D(double[] x,
                                double[] y)

Creates a 2D polygon with vertices at the provided x, y coordinates. If the x and y arrays have unequal lengths, the longer array will be truncated.

Parameters:

x - X coordinates of the vertices which will be copied

y - Y coordinates of the vertices which will be copied

Method Detail

test

public boolean test(RealLocalizable localizable)

Return true if the given point is contained inside the boundary. See: http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html

Specified by:

test in interface Predicate<RealLocalizable>

vertex

public RealLocalizableRealPositionable vertex(int pos)

Return a copy of the vertex

Specified by:

vertex in interface Polygon2D

Specified by:

vertex in interface WritablePolygon2D

numVertices

public int numVertices()

Description copied from interface: Polygon2D

Get the number of vertices

Specified by:

numVertices in interface Polygon2D

addVertex

public void addVertex(int index,
                      double[] vertex)

If the given vertex has more than 2 dimensions, the higher dimensions will be ignored.

Specified by:

addVertex in interface WritablePolygon2D

removeVertex

public void removeVertex(int index)

Description copied from interface: WritablePolygon2D

Removes the vertex at the given index.

Specified by:

removeVertex in interface WritablePolygon2D

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object