DefaultWritablePolyline (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractRealInterval
  - - net.imglib2.roi.geom.real.DefaultWritablePolyline

All Implemented Interfaces:

Predicate<RealLocalizable>, EuclideanSpace, RealInterval, Polyline, Polyshape, WritablePolyline, WritablePolyshape, MaskPredicate<RealLocalizable>, RealMask, RealMaskRealInterval
```
public class DefaultWritablePolyline
extends AbstractRealInterval
implements WritablePolyline
```
A polyline, which can be embedded in n-dimensional space.

Author:

Alison Walter

Field Summary
- Fields inherited from class net.imglib2.AbstractRealInterval
  max, min
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Constructor Summary

Constructors
Constructor and Description

DefaultWritablePolyline(List<? extends RealLocalizable> vertices)
Creates a polyline with the specified vertices.

Constructors
Constructor and Description
`DefaultWritablePolyline(List<? extends RealLocalizable> vertices)` Creates a polyline with the specified vertices.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVertex(int index, RealLocalizable vertex)` Adds a vertex at the given index.
`void`	`addVertices(int index, Collection<RealLocalizable> newVertices)` Adds vertices starting at the given index.
`boolean`	`equals(Object obj)` Determines whether this polyline describes the same region as another one.
`int`	`hashCode()`
`int`	`numVertices()` Returns the number of vertices in the shape.
`void`	`removeVertex(int index)` Removes the vertex at the given index.
`boolean`	`test(RealLocalizable l)`
`RealLocalizableRealPositionable`	`vertex(int pos)` Returns the vertex at the specified position.

Methods inherited from class net.imglib2.AbstractRealInterval
realMax, realMax, realMax, realMin, realMin, realMin, toString

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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

Methods inherited from interface net.imglib2.roi.geom.real.Polyline
boundaryType, hashCode, maskType

Methods inherited from interface net.imglib2.roi.geom.real.Polyshape
equals, vertices

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
isAll, knownConstant

Methods inherited from interface java.util.function.Predicate
isEqual

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

- Constructor Detail
  - DefaultWritablePolyline
```
public DefaultWritablePolyline(List<? extends RealLocalizable> vertices)
```
    Creates a polyline with the specified vertices. The dimensionality of the space is determined by the dimensionality of the first vertex. If a given vertex has fewer dimensions then an exception will be thrown. However, if the given vertex has more dimensions it will be truncated.
    
    Parameters:
    
    vertices - Vertices which define the polyline in the desired order.
- Method Detail
  - test
```
public boolean test(RealLocalizable l)
```
    Specified by:
    
    test in interface Predicate<RealLocalizable>
  - vertex
```
public RealLocalizableRealPositionable vertex(int pos)
```
    Returns the vertex at the specified position. The vertices are in the same order as when they were passed to the constructor, unless vertices have been added/removed.
    
    Specified by:
    
    vertex in interface Polyshape
    
    Specified by:
    
    vertex in interface WritablePolyshape
  - numVertices
```
public int numVertices()
```
    Description copied from interface: Polyshape
    
    Returns the number of vertices in the shape.
    
    Specified by:
    
    numVertices in interface Polyshape
  - addVertex
```
public void addVertex(int index,
                      RealLocalizable vertex)
```
    Description copied from interface: WritablePolyshape
    
    Adds a vertex at the given index.
    
    Specified by:
    
    addVertex in interface WritablePolyshape
  - removeVertex
```
public void removeVertex(int index)
```
    Description copied from interface: WritablePolyshape
    
    Removes the vertex at the given index.
    
    Specified by:
    
    removeVertex in interface WritablePolyshape
  - addVertices
```
public void addVertices(int index,
                        Collection<RealLocalizable> newVertices)
```
    Description copied from interface: WritablePolyshape
    
    Adds vertices starting at the given index.
    
    Specified by:
    
    addVertices in interface WritablePolyshape
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: Polyline
    
    Determines whether this polyline describes the same region as another one.
    
    Specified by:
    
    equals in interface Polyline
    
    Specified by:
    
    equals in interface MaskPredicate<RealLocalizable>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - The polyline to compare with this one.
    
    Returns:
    
    True iff the polylines describe the same region.
    
    See Also:
    
    MaskPredicate.equals(Object), Polyshape.equals(Polyshape, Polyshape)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DefaultWritablePolyline

Field Summary

Fields inherited from class net.imglib2.AbstractRealInterval

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractRealInterval

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.roi.geom.real.Polyline

Methods inherited from interface net.imglib2.roi.geom.real.Polyshape

Methods inherited from interface net.imglib2.roi.RealMaskRealInterval

Methods inherited from interface net.imglib2.roi.RealMask

Methods inherited from interface net.imglib2.roi.MaskPredicate

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface net.imglib2.RealInterval

Constructor Detail

DefaultWritablePolyline

Method Detail

test

vertex

numVertices

addVertex

removeVertex

addVertices

equals

hashCode