Localizable (ImgLib2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

EuclideanSpace, RealLocalizable

All Known Subinterfaces:

BSplineCoefficientsInterpolator<T>, Cursor<T>, Neighborhood<T>, OutOfBounds<T>, PositionableIterableInterval<T>, PositionableIterableRegion<T>, PositionableLocalizable, RandomAccess<T>, RealOutOfBounds<T>

All Known Implementing Classes:

AbstractArrayCursor, AbstractArrayLocalizingCursor, AbstractConvertedCursor, AbstractConvertedRandomAccess, AbstractCursor, AbstractCursorInt, AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor, AbstractLocalizable, AbstractLocalizableInt, AbstractLocalizingCursor, AbstractLocalizingCursorInt, AbstractLongListImg.LongListCursor, AbstractLongListImg.LongListLocalizingCursor, AbstractLongListImg.LongListRandomAccess, AbstractNeighborhoodCursor, AbstractOutOfBoundsMirror, AbstractOutOfBoundsValue, AbstractProjector2D, AbstractUnsafeCursor, AbstractUnsafeLocalizingCursor, AbstractWrappedLocalizable, AbstractWrappedPositionableLocalizable, AffineRandomAccessible.AffineRandomAccess, ArrayCursor, ArrayImgXYByteProjector, ArrayImgXYShortProjector, ArrayLocalizingCursor, ArrayLocalizingSubIntervalCursor, ArrayRandomAccess, ArraySubIntervalCursor, BiConvertedCursor, BiConvertedRandomAccess, BinaryMaskRegionOfInterest.BMROIIterableInterval.BMROICursor, BoundaryRandomAccess4, BoundaryRandomAccess8, BresenhamLine, BSplineCoefficientsInterpolatorEven, BSplineCoefficientsInterpolatorOdd, BufferedRectangularNeighborhoodCursor, CellCursor, CellLocalizingCursor, CellRandomAccess, CircleCursor, CompositeView.CompositeRandomAccess, CompositeXYProjector, CompositeXYRandomAccessibleProjector, ConvertedCursor, ConvertedRandomAccess, DiamondNeighborhood, DiamondNeighborhood.LocalCursor, DiamondNeighborhoodCursor, DiamondNeighborhoodLocalizableSampler, DiamondNeighborhoodRandomAccess, DiamondNeighborhoodUnsafe, DiamondTipsNeighborhood, DiamondTipsNeighborhood.LocalCursor, DiamondTipsNeighborhoodCursor, DiamondTipsNeighborhoodLocalizableSampler, DiamondTipsNeighborhoodRandomAccess, DiamondTipsNeighborhoodUnsafe, EllipseCursor, EllipseCursor, EllipsoidCursor, FullSourceMapMixedRandomAccess, FullSourceMapSlicingRandomAccess, FunctionCursor, FunctionCursorDouble, FunctionCursorDoubleIncompatibleOrder, FunctionCursorIncompatibleOrder, FunctionRandomAccess, FunctionRandomAccessDouble, FunctionRandomAccessible.FunctionRandomAccess, HorizontalLineNeighborhood, HorizontalLineNeighborhood.LocalCursor, HorizontalLineNeighborhoodCursor, HorizontalLineNeighborhoodLocalizableSampler, HorizontalLineNeighborhoodRandomAccess, HorizontalLineNeighborhoodUnsafe, HyperSlice.HyperSliceRandomAccess, HyperSlicesView.HyperSlicesViewRandomAccess, HyperSphereCursor, HyperSphereNeighborhood, HyperSphereNeighborhood.LocalCursor, HyperSphereNeighborhoodCursor, HypersphereNeighborhoodLocalizableSampler, HyperSphereNeighborhoodRandomAccess, HyperSphereNeighborhoodUnsafe, IntervalIterator, IterableIntervalProjector2D, IterationCodeCursor, IterationCodeListCursor, KDTreeRadiusSource, LabelingConvertedCursor, LabelingConvertedRandomAccess, LabelingOutOfBoundsRandomAccess, LabelRegion, LabelRegionCursor, LabelRegionRandomAccess, ListCursor, ListLocalizingCursor, ListRandomAccess, LocalizingIntervalIterator, LocalizingZeroMinIntervalIterator, LocalNeighborhoodCursor, LocalNeighborhoodCursor, LocalNeighborhoodCursor2, MaskPredicateRandomAccess, MixedRandomAccess, MultithreadedIterableIntervalProjector2D, NtreeCursor, NtreeRandomAccess, OffsetableIntervalIterator, OffsetableLocalizingIntervalIterator, OffsetLocalizable, OffsetPositionableLocalizable, OutOfBoundsBorder, OutOfBoundsConstantValue, OutOfBoundsMirrorDoubleBoundary, OutOfBoundsMirrorExpWindowing, OutOfBoundsMirrorSingleBoundary, OutOfBoundsPeriodic, OutOfBoundsRandomValue, PairOfPointsNeighborhood, PairOfPointsNeighborhood.LocalCursor, PairOfPointsNeighborhoodCursor, PairOfPointsNeighborhoodLocalizableSampler, PairOfPointsNeighborhoodRandomAccess, PairOfPointsNeighborhoodUnsafe, PeriodicLineNeighborhood, PeriodicLineNeighborhood.LocalCursor, PeriodicLineNeighborhoodCursor, PeriodicLineNeighborhoodLocalizableSampler, PeriodicLineNeighborhoodRandomAccess, PeriodicLineNeighborhoodUnsafe, PlanarCursor, PlanarCursor1D, PlanarCursor2D, PlanarImgXYByteProjector, PlanarImgXYShortProjector, PlanarLocalizingCursor, PlanarLocalizingCursor1D, PlanarLocalizingCursor2D, PlanarPlaneSubsetCursor, PlanarPlaneSubsetLocalizingCursor, PlanarRandomAccess, PlanarRandomAccess1D, Point, PointSampleList.PointSampleListCursor, PositionableInterval, PositionableWrappedIterableInterval, PositionableWrappedIterableRegion, PositionRandomAccessible.PositionRandomAccess, PositionRandomAccessible.PositionRandomAccess, RandomAccessibleIntervalCursor, RandomAccessibleOnRealRandomAccessible.RandomAccessOnRealRandomAccessible, RandomAccessiblePair.RandomAccess, RandomAccessibleProjector2D, RandomAccessibleRegionCursor, RealTransformRandomAccessible.RealTransformRandomAccess, RectangleCursor, RectangleNeighborhood, RectangleNeighborhood.LocalCursor, RectangleNeighborhoodCursor, RectangleNeighborhoodLocalizableSampler, RectangleNeighborhoodRandomAccess, RectangleNeighborhoodSkipCenter, RectangleNeighborhoodSkipCenter.LocalCursor, RectangleNeighborhoodSkipCenterUnsafe, RectangleNeighborhoodUnsafe, SamplingCursor, SamplingProjector2D, ScaleAsFunctionOfPosition.ScaledRandomAccess, SlicingCursor, SlicingRandomAccess, StackView.DefaultRA, StackView.MoveAllSlicesRA, SubsampleView.SubsampleRandomAccess, TransformRandomAccess, TranslationRandomAccess, UnsafeCursor, UnsafeLocalizingCursor, UnsafeLocalizingSubIntervalCursor, UnsafeRandomAccess, UnsafeSubIntervalCursor, Volatile2DRandomAccessibleProjector, WriteConvertedCursor, WriteConvertedRandomAccess, ZeroMinIntervalIterator
```
public interface Localizable
extends RealLocalizable
```
The Localizable interface can localize itself in an n-dimensional discrete space. Not only Cursors can use this interface, it might be used by much more classes as RandomAccesss can take any Localizable as input for where they should move to.

Author:

Stephan Preibisch, Stephan Saalfeld

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default double`	`getDoublePosition(int d)` Return the current position in a given dimension.
`default float`	`getFloatPosition(int d)` Return the current position in a given dimension.
`default int`	`getIntPosition(int d)` Return the current position in a given dimension.
`long`	`getLongPosition(int d)` Return the current position in a given dimension.
`default void`	`localize(int[] position)` Write the current position into the passed array.
`default void`	`localize(long[] position)` Write the current position into the passed array.
`default void`	`localize(Positionable position)` Write the current position into the passed `Positionable`.
`default long[]`	`positionAsLongArray()` Allocate and return a long array containing the localizable's position.
`default Point`	`positionAsPoint()` Allocate and return a `Point` containing the localizable's position.

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Method Detail
  - localize
```
default void localize(int[] position)
```
    Write the current position into the passed array.
    
    Parameters:
    
    position - receives current position
  - localize
```
default void localize(long[] position)
```
    Write the current position into the passed array.
    
    Parameters:
    
    position - receives current position
  - localize
```
default void localize(Positionable position)
```
    Write the current position into the passed Positionable. Note for developers: This default implementation forwards to Positionable.setPosition(Localizable), so don't do the same there.
    
    Parameters:
    
    position - receives current position
  - getIntPosition
```
default int getIntPosition(int d)
```
    Return the current position in a given dimension.
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - positionAsLongArray
```
default long[] positionAsLongArray()
```
    Allocate and return a long array containing the localizable's position. Please note that his method allocates a new array each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated array first and reuse it with localize(long[]).
    
    Returns:
    
    the position
  - positionAsPoint
```
default Point positionAsPoint()
```
    Allocate and return a Point containing the localizable's position. Please note that his method allocates a new Point each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated Point first and reuse it with localize(Positionable).
    
    Returns:
    
    the position
  - getLongPosition
```
long getLongPosition(int d)
```
    Return the current position in a given dimension.
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getFloatPosition
```
default float getFloatPosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
default double getDoublePosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position

Interface Localizable

Method Summary

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.EuclideanSpace

Method Detail

localize

localize

localize

getIntPosition

positionAsLongArray

positionAsPoint

getLongPosition

getFloatPosition

getDoublePosition