AbstractNeighborhood (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.algorithm.region.localneighborhood.AbstractNeighborhood<T>

All Implemented Interfaces:

Iterable<T>, Dimensions, EuclideanSpace, Interval, IterableInterval<T>, IterableRealInterval<T>, Positionable, RealInterval

Direct Known Subclasses:

BufferedRectangularNeighborhood, EllipseNeighborhood, EllipsoidNeighborhood, HyperSphereNeighborhoodGPL, RectangleNeighborhoodGPL
```
public abstract class AbstractNeighborhood<T>
extends Object
implements Positionable, IterableInterval<T>
```
A Positionable IterableInterval that serves as a local neighborhood, e.g. in filtering operation.
This particular class implements a movable nD domain, defined by a span long[] array. The span array is such that the bounding box of the neighborhood in dimension d will be 2 x span[d] + 1.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long[]`	`center` The pixel coordinates of the center of this regions.
`protected ExtendedRandomAccessibleInterval<T,RandomAccessibleInterval<T>>`	`extendedSource`
`protected int`	`n`
`protected OutOfBoundsFactory<T,RandomAccessibleInterval<T>>`	`outOfBounds`
`protected RandomAccessibleInterval<T>`	`source`
`protected long[]`	`span` The span of this neighborhood, such that the size of the bounding box in dimension `d` will be `2 x span[d] + 1`.

Constructor Summary

Constructors
Constructor and Description

AbstractNeighborhood(int numDims, OutOfBoundsFactory<T,RandomAccessibleInterval<T>> outOfBounds)

Constructors
Constructor and Description
`AbstractNeighborhood(int numDims, OutOfBoundsFactory<T,RandomAccessibleInterval<T>> outOfBounds)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int d)` Move by -1 in one dimension.
`abstract AbstractNeighborhood<T>`	`copy()` Copies the `AbstractNeighborhood`.
`long`	`dimension(int d)` Default implementation of `Dimensions.dimension(int)`.
`void`	`dimensions(long[] dimensions)` Write the number of pixels in each dimension into long[].
`T`	`firstElement()` Return the element at the top-left corner of this nD neighborhood.
`void`	`fwd(int d)` Move by 1 in one dimension.
`Object`	`iterationOrder()` Returns the iteration order of this `IterableRealInterval`.
`long`	`max(int d)` Get the maximum in dimension d.
`void`	`max(long[] max)` Write the maximum of each dimension into long[].
`void`	`max(Positionable max)` Sets a `Positionable` to the maximum of this `Interval`
`long`	`min(int d)` Get the minimum in dimension d.
`void`	`min(long[] min)` Write the minimum of each dimension into long[].
`void`	`min(Positionable min)` Sets a `Positionable` to the minimum of this `Interval`
`void`	`move(int[] distance)` Move the element relative to its current location using an int[] as distance vector.
`void`	`move(int distance, int d)` Move the element in one dimension for some distance.
`void`	`move(Localizable localizable)` Move the element relative to its current location using an `Localizable` as distance vector.
`void`	`move(long[] distance)` Move the element relative to its current location using a long[] as distance vector.
`void`	`move(long distance, int d)` Move the element in one dimension for some distance.
`int`	`numDimensions()` Gets the space's number of dimensions.
`void`	`realMax(double[] max)` Write the maximum of each dimension into double[].
`double`	`realMax(int d)` Get the maximum in dimension d.
`void`	`realMax(RealPositionable max)` Sets a `RealPositionable` to the maximum of this `Interval`
`void`	`realMin(double[] min)` Write the minimum of each dimension into double[].
`double`	`realMin(int d)` Get the minimum in dimension d.
`void`	`realMin(RealPositionable min)` Sets a `RealPositionable` to the minimum of this `Interval`
`void`	`setPosition(int[] position)` Set the position of the element.
`void`	`setPosition(int position, int d)` Set the position of the element for one dimension.
`void`	`setPosition(Localizable localizable)` Place the element at the same location as a given `Localizable`
`void`	`setPosition(long[] position)` Set the position of the element.
`void`	`setPosition(long position, int d)` Set the position of the element for one dimension.
`void`	`setSpan(long[] span)` Set the span of this neighborhood.
`void`	`updateSource(RandomAccessibleInterval<T> source)` Updates the source.

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

Methods inherited from interface net.imglib2.IterableInterval
cursor, localizingCursor

Methods inherited from interface net.imglib2.IterableRealInterval
size

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface net.imglib2.Interval
maxAsLongArray, maxAsPoint, minAsLongArray, minAsPoint

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

Methods inherited from interface net.imglib2.Dimensions
allPositive, allPositive, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

- Field Detail
  - center
```
protected final long[] center
```
    The pixel coordinates of the center of this regions.
  - span
```
protected final long[] span
```
    The span of this neighborhood, such that the size of the bounding box in dimension d will be 2 x span[d] + 1.
  - extendedSource
```
protected ExtendedRandomAccessibleInterval<T,RandomAccessibleInterval<T>> extendedSource
```
  - source
```
protected RandomAccessibleInterval<T> source
```
  - outOfBounds
```
protected OutOfBoundsFactory<T,RandomAccessibleInterval<T>> outOfBounds
```
  - n
```
protected int n
```
- Constructor Detail
  - AbstractNeighborhood
```
public AbstractNeighborhood(int numDims,
                            OutOfBoundsFactory<T,RandomAccessibleInterval<T>> outOfBounds)
```
- Method Detail
  - setSpan
```
public void setSpan(long[] span)
```
    Set the span of this neighborhood.
    The neighborhood span is such that the size of the neighborhood in dimension d will be 2 x span[d] + 1.
    
    Parameters:
    
    span - this array content will be copied to the neighborhood internal field.
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - fwd
```
public void fwd(int d)
```
    Description copied from interface: Positionable
    
    Move by 1 in one dimension.
    
    Specified by:
    
    fwd in interface Positionable
    
    Parameters:
    
    d - dimension
  - bck
```
public void bck(int d)
```
    Description copied from interface: Positionable
    
    Move by -1 in one dimension.
    
    Specified by:
    
    bck in interface Positionable
    
    Parameters:
    
    d - dimension
  - move
```
public void move(int distance,
                 int d)
```
    Description copied from interface: Positionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset in dimension d
    
    d - dimension
  - move
```
public void move(long distance,
                 int d)
```
    Description copied from interface: Positionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset in dimension d
    
    d - dimension
  - move
```
public void move(Localizable localizable)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using an Localizable as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(int[] distance)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using an int[] as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(long[] distance)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using a long[] as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(Localizable localizable)
```
    Description copied from interface: Positionable
    
    Place the element at the same location as a given Localizable
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(int[] position)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(long[] position)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(int position,
                        int d)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position in dimension d
    
    d - dimension
  - setPosition
```
public void setPosition(long position,
                        int d)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position in dimension d
    
    d - dimension
  - firstElement
```
public T firstElement()
```
    Return the element at the top-left corner of this nD neighborhood.
    
    Specified by:
    
    firstElement in interface IterableRealInterval<T>
    
    Returns:
    
    the first element in iteration order.
  - iterationOrder
```
public Object iterationOrder()
```
    Description copied from interface: IterableRealInterval
    
    Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.
    
    Specified by:
    
    iterationOrder in interface IterableRealInterval<T>
    
    Returns:
    
    the iteration order of this IterableRealInterval.
    
    See Also:
    
    FlatIterationOrder
  - realMin
```
public double realMin(int d)
```
    Description copied from interface: RealInterval
    
    Get the minimum in dimension d.
    
    Specified by:
    
    realMin in interface Interval
    
    Specified by:
    
    realMin in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - realMin
```
public void realMin(double[] min)
```
    Description copied from interface: RealInterval
    
    Write the minimum of each dimension into double[].
    
    Specified by:
    
    realMin in interface RealInterval
  - realMin
```
public void realMin(RealPositionable min)
```
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the minimum of this Interval
    
    Specified by:
    
    realMin in interface RealInterval
  - realMax
```
public double realMax(int d)
```
    Description copied from interface: RealInterval
    
    Get the maximum in dimension d.
    
    Specified by:
    
    realMax in interface Interval
    
    Specified by:
    
    realMax in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - realMax
```
public void realMax(double[] max)
```
    Description copied from interface: RealInterval
    
    Write the maximum of each dimension into double[].
    
    Specified by:
    
    realMax in interface RealInterval
  - realMax
```
public void realMax(RealPositionable max)
```
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the maximum of this Interval
    
    Specified by:
    
    realMax in interface RealInterval
  - min
```
public long min(int d)
```
    Description copied from interface: Interval
    
    Get the minimum in dimension d.
    
    Specified by:
    
    min in interface Interval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - min
```
public void min(long[] min)
```
    Description copied from interface: Interval
    
    Write the minimum of each dimension into long[].
    
    Specified by:
    
    min in interface Interval
  - min
```
public void min(Positionable min)
```
    Description copied from interface: Interval
    
    Sets a Positionable to the minimum of this Interval
    
    Specified by:
    
    min in interface Interval
  - max
```
public long max(int d)
```
    Description copied from interface: Interval
    
    Get the maximum in dimension d.
    
    Specified by:
    
    max in interface Interval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - max
```
public void max(long[] max)
```
    Description copied from interface: Interval
    
    Write the maximum of each dimension into long[].
    
    Specified by:
    
    max in interface Interval
  - max
```
public void max(Positionable max)
```
    Description copied from interface: Interval
    
    Sets a Positionable to the maximum of this Interval
    
    Specified by:
    
    max in interface Interval
  - dimensions
```
public void dimensions(long[] dimensions)
```
    Description copied from interface: Dimensions
    
    Write the number of pixels in each dimension into long[].
    
    Specified by:
    
    dimensions in interface Dimensions
  - dimension
```
public long dimension(int d)
```
    Description copied from interface: Interval
    
    Default implementation of Dimensions.dimension(int).
    
    Specified by:
    
    dimension in interface Dimensions
    
    Specified by:
    
    dimension in interface Interval
  - updateSource
```
public void updateSource(RandomAccessibleInterval<T> source)
```
    Updates the source.
  - copy
```
public abstract AbstractNeighborhood<T> copy()
```
    Copies the AbstractNeighborhood.

Class AbstractNeighborhood<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.IterableInterval

Methods inherited from interface net.imglib2.IterableRealInterval

Methods inherited from interface java.lang.Iterable

Methods inherited from interface net.imglib2.Interval

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.Dimensions

Field Detail

center

span

extendedSource

source

outOfBounds

n

Constructor Detail

AbstractNeighborhood

Method Detail

setSpan

numDimensions

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

firstElement

iterationOrder

realMin

realMin

realMin

realMax

realMax

realMax

min

min

min

max

max

max

dimensions

dimension

updateSource

copy