DiamondTipsNeighborhood (ImgLib2 Algorithms 0.18.1 API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizable
  - - net.imglib2.algorithm.neighborhood.DiamondTipsNeighborhood<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<T>, Neighborhood<T>, net.imglib2.Dimensions, net.imglib2.EuclideanSpace, net.imglib2.Interval, net.imglib2.IterableInterval<T>, net.imglib2.IterableRealInterval<T>, net.imglib2.Localizable, net.imglib2.RealInterval, net.imglib2.RealLocalizable, net.imglib2.Typed<T>

Direct Known Subclasses:

DiamondTipsNeighborhoodUnsafe
```
public class DiamondTipsNeighborhood<T>
extends net.imglib2.AbstractLocalizable
implements Neighborhood<T>
```
A Neighborhood that iterates through the tips of a multi-dimensional diamond.
Though it has very few direct applications, it is used in structuring element decomposition for mathematical morphology.

Author:

Jean-Yves Tinevez Nov 6, 2013

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DiamondTipsNeighborhood.LocalCursor

Nested Classes
Modifier and Type	Class and Description
`class`	`DiamondTipsNeighborhood.LocalCursor`

Field Summary
- Fields inherited from class net.imglib2.AbstractLocalizable
  position
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Constructor Summary

Constructors
Constructor and Description
`DiamondTipsNeighborhood(long[] position, long radius, net.imglib2.RandomAccess<T> sourceRandomAccess)` Creates a new diamond tip neighborhood.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DiamondTipsNeighborhood.LocalCursor`	`cursor()`
`long`	`dimension(int d)`
`void`	`dimensions(long[] dimensions)`
`static <T> DiamondTipsNeighborhoodFactory<T>`	`factory()`
`T`	`firstElement()`
`net.imglib2.Interval`	`getStructuringElementBoundingBox()`
`T`	`getType()`
`Object`	`iterationOrder()`
`Iterator<T>`	`iterator()`
`DiamondTipsNeighborhood.LocalCursor`	`localizingCursor()`
`long`	`max(int d)`
`void`	`max(long[] max)`
`void`	`max(net.imglib2.Positionable max)`
`long`	`min(int d)`
`void`	`min(long[] min)`
`void`	`min(net.imglib2.Positionable min)`
`void`	`realMax(double[] max)`
`double`	`realMax(int d)`
`void`	`realMax(net.imglib2.RealPositionable max)`
`void`	`realMin(double[] min)`
`double`	`realMin(int d)`
`void`	`realMin(net.imglib2.RealPositionable min)`
`long`	`size()`

Methods inherited from class net.imglib2.AbstractLocalizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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
localizingSpliterator, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval
parallelStream, stream

Methods inherited from interface java.lang.Iterable
forEach

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.Localizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable
localize, localize, positionAsDoubleArray, positionAsRealPoint

- Constructor Detail
  - DiamondTipsNeighborhood
```
public DiamondTipsNeighborhood(long[] position,
                               long radius,
                               net.imglib2.RandomAccess<T> sourceRandomAccess)
```
    Creates a new diamond tip neighborhood.
    
    Parameters:
    
    position - the central position of the diamond.
    
    radius - the diamond radius in all dimensions.
    
    sourceRandomAccess - a RandomAccess on the target source.
- Method Detail
  - factory
```
public static <T> DiamondTipsNeighborhoodFactory<T> factory()
```
  - cursor
```
public DiamondTipsNeighborhood.LocalCursor cursor()
```
    Specified by:
    
    cursor in interface net.imglib2.IterableInterval<T>
    
    Specified by:
    
    cursor in interface net.imglib2.IterableRealInterval<T>
  - localizingCursor
```
public DiamondTipsNeighborhood.LocalCursor localizingCursor()
```
    Specified by:
    
    localizingCursor in interface net.imglib2.IterableInterval<T>
    
    Specified by:
    
    localizingCursor in interface net.imglib2.IterableRealInterval<T>
  - size
```
public long size()
```
    Specified by:
    
    size in interface net.imglib2.IterableRealInterval<T>
  - firstElement
```
public T firstElement()
```
    Specified by:
    
    firstElement in interface net.imglib2.IterableRealInterval<T>
  - getType
```
public T getType()
```
    Specified by:
    
    getType in interface net.imglib2.IterableRealInterval<T>
    
    Specified by:
    
    getType in interface net.imglib2.Typed<T>
  - iterationOrder
```
public Object iterationOrder()
```
    Specified by:
    
    iterationOrder in interface net.imglib2.IterableRealInterval<T>
  - realMin
```
public double realMin(int d)
```
    Specified by:
    
    realMin in interface net.imglib2.Interval
    
    Specified by:
    
    realMin in interface net.imglib2.RealInterval
  - realMin
```
public void realMin(double[] min)
```
    Specified by:
    
    realMin in interface net.imglib2.RealInterval
  - realMin
```
public void realMin(net.imglib2.RealPositionable min)
```
    Specified by:
    
    realMin in interface net.imglib2.RealInterval
  - realMax
```
public double realMax(int d)
```
    Specified by:
    
    realMax in interface net.imglib2.Interval
    
    Specified by:
    
    realMax in interface net.imglib2.RealInterval
  - realMax
```
public void realMax(double[] max)
```
    Specified by:
    
    realMax in interface net.imglib2.RealInterval
  - realMax
```
public void realMax(net.imglib2.RealPositionable max)
```
    Specified by:
    
    realMax in interface net.imglib2.RealInterval
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface net.imglib2.IterableRealInterval<T>
  - min
```
public long min(int d)
```
    Specified by:
    
    min in interface net.imglib2.Interval
  - min
```
public void min(long[] min)
```
    Specified by:
    
    min in interface net.imglib2.Interval
  - min
```
public void min(net.imglib2.Positionable min)
```
    Specified by:
    
    min in interface net.imglib2.Interval
  - max
```
public long max(int d)
```
    Specified by:
    
    max in interface net.imglib2.Interval
  - max
```
public void max(long[] max)
```
    Specified by:
    
    max in interface net.imglib2.Interval
  - max
```
public void max(net.imglib2.Positionable max)
```
    Specified by:
    
    max in interface net.imglib2.Interval
  - dimensions
```
public void dimensions(long[] dimensions)
```
    Specified by:
    
    dimensions in interface net.imglib2.Dimensions
  - dimension
```
public long dimension(int d)
```
    Specified by:
    
    dimension in interface net.imglib2.Dimensions
    
    Specified by:
    
    dimension in interface net.imglib2.Interval
  - getStructuringElementBoundingBox
```
public net.imglib2.Interval getStructuringElementBoundingBox()
```
    Specified by:
    
    getStructuringElementBoundingBox in interface Neighborhood<T>

Class DiamondTipsNeighborhood<T>

Nested Class Summary

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizable

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractLocalizable

Methods inherited from class net.imglib2.AbstractEuclideanSpace

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

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Constructor Detail

DiamondTipsNeighborhood

Method Detail

factory

cursor

localizingCursor

size

firstElement

getType

iterationOrder

realMin

realMin

realMin

realMax

realMax

realMax

iterator

min

min

min

max

max

max

dimensions

dimension

getStructuringElementBoundingBox