RealLocalizable (ImgLib2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

EuclideanSpace

All Known Subinterfaces:

BSplineCoefficientsInterpolator<T>, Cursor<T>, Localizable, Neighborhood<T>, OutOfBounds<T>, PointMask, PositionableIterableInterval<T>, PositionableIterableRegion<T>, PositionableLocalizable, RandomAccess<T>, RealCursor<T>, RealLocalizableRealPositionable, RealOutOfBounds<T>, RealRandomAccess<T>, WritablePointMask

All Known Implementing Classes:

AbstractArrayCursor, AbstractArrayLocalizingCursor, AbstractConvertedCursor, AbstractConvertedRandomAccess, AbstractConvertedRealCursor, AbstractConvertedRealRandomAccess, AbstractCursor, AbstractCursorInt, AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor, AbstractLocalizable, AbstractLocalizableInt, AbstractLocalizingCursor, AbstractLocalizingCursorInt, AbstractLongListImg.LongListCursor, AbstractLongListImg.LongListLocalizingCursor, AbstractLongListImg.LongListRandomAccess, AbstractNeighborhoodCursor, AbstractOutOfBoundsMirror, AbstractOutOfBoundsValue, AbstractPositionableTransform, AbstractProjector2D, AbstractRealLocalizable, AbstractRealMaskPoint, AbstractRegionOfInterest.AROIRandomAccess, AbstractUnsafeCursor, AbstractUnsafeLocalizingCursor, AbstractWrappedLocalizable, AbstractWrappedPositionableLocalizable, AffineRandomAccessible.AffineRandomAccess, AffineRealRandomAccessible.AffineRealRandomAccess, ArrayCursor, ArrayImgXYByteProjector, ArrayImgXYShortProjector, ArrayLocalizingCursor, ArrayLocalizingSubIntervalCursor, ArrayRandomAccess, ArraySubIntervalCursor, BiConvertedCursor, BiConvertedRandomAccess, BiConvertedRealCursor, BiConvertedRealRandomAccess, BinaryMaskRegionOfInterest.BMROIIterableInterval.BMROICursor, BoundaryRandomAccess4, BoundaryRandomAccess8, BresenhamLine, BSplineCoefficientsInterpolatorEven, BSplineCoefficientsInterpolatorOdd, BSplineInterpolator, BufferedRectangularNeighborhoodCursor, CellCursor, CellLocalizingCursor, CellRandomAccess, CircleCursor, ClampingNLinearInterpolatorRealType, ClampingNLinearInterpolatorVolatileARGB, ClampingNLinearInterpolatorVolatileRealType, CompositeView.CompositeRandomAccess, CompositeXYProjector, CompositeXYRandomAccessibleProjector, ConvertedCursor, ConvertedRandomAccess, ConvertedRealCursor, ConvertedRealRandomAccess, DefaultWritablePointMask, DiamondNeighborhood, DiamondNeighborhood.LocalCursor, DiamondNeighborhoodCursor, DiamondNeighborhoodLocalizableSampler, DiamondNeighborhoodRandomAccess, DiamondNeighborhoodUnsafe, DiamondTipsNeighborhood, DiamondTipsNeighborhood.LocalCursor, DiamondTipsNeighborhoodCursor, DiamondTipsNeighborhoodLocalizableSampler, DiamondTipsNeighborhoodRandomAccess, DiamondTipsNeighborhoodUnsafe, Edgel, EllipseCursor, EllipseCursor, EllipsoidCursor, Floor, FloorInterpolator, FloorOffset, FullSourceMapMixedRandomAccess, FullSourceMapSlicingRandomAccess, FunctionCursor, FunctionCursorDouble, FunctionCursorDoubleIncompatibleOrder, FunctionCursorIncompatibleOrder, FunctionRandomAccess, FunctionRandomAccessDouble, FunctionRandomAccessible.FunctionRandomAccess, FunctionRealRandomAccessible.RealFunctionRealRandomAccess, HorizontalLineNeighborhood, HorizontalLineNeighborhood.LocalCursor, HorizontalLineNeighborhoodCursor, HorizontalLineNeighborhoodLocalizableSampler, HorizontalLineNeighborhoodRandomAccess, HorizontalLineNeighborhoodUnsafe, HyperSlice.HyperSliceRandomAccess, HyperSlicesView.HyperSlicesViewRandomAccess, HyperSphereCursor, HyperSphereNeighborhood, HyperSphereNeighborhood.LocalCursor, HyperSphereNeighborhoodCursor, HypersphereNeighborhoodLocalizableSampler, HyperSphereNeighborhoodRandomAccess, HyperSphereNeighborhoodUnsafe, IntervalIterator, InverseDistanceWeightingInterpolator, IterableIntervalProjector2D, IterationCodeCursor, IterationCodeListCursor, KDTree.KDTreeCursor, KDTree.SamplerNode, KDTree.ValueNode, KDTreeNode, KDTreeRadiusSource, LabelingConvertedCursor, LabelingConvertedRandomAccess, LabelingOutOfBoundsRandomAccess, LabelRegion, LabelRegionCursor, LabelRegionRandomAccess, LanczosInterpolator, LinearRealRandomAccessibleStackInterpolator, ListCursor, ListLocalizingCursor, ListRandomAccess, LocalizingIntervalIterator, LocalizingZeroMinIntervalIterator, LocalNeighborhoodCursor, LocalNeighborhoodCursor, LocalNeighborhoodCursor2, MaskPredicateRandomAccess, MaskPredicateRealRandomAccess, MixedRandomAccess, MultithreadedIterableIntervalProjector2D, NearestNeighborInterpolator, NearestNeighborRealRandomAccessibleStackInterpolator, NearestNeighborSearchInterpolator, NLinearInterpolator, NLinearInterpolator1D, NLinearInterpolator2D, NLinearInterpolator3D, NLinearInterpolatorARGB, 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, RealLocalizableRealPositionableWrapper, RealOutOfBoundsRealRandomAccess, RealPoint, RealPointSampleList.RealPointSampleListCursor, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, RealTransformRandomAccessible.RealTransformRandomAccess, RealTransformRealRandomAccessible.RealTransformRealRandomAccess, RectangleCursor, RectangleNeighborhood, RectangleNeighborhood.LocalCursor, RectangleNeighborhoodCursor, RectangleNeighborhoodLocalizableSampler, RectangleNeighborhoodRandomAccess, RectangleNeighborhoodSkipCenter, RectangleNeighborhoodSkipCenter.LocalCursor, RectangleNeighborhoodSkipCenterUnsafe, RectangleNeighborhoodUnsafe, RefinedPeak, Round, SamplingCursor, SamplingProjector2D, ScaleAsFunctionOfPosition.ScaledRandomAccess, SlicingCursor, SlicingRandomAccess, StackingRealRandomAccessible.StackingRealRandomAccess, StackView.DefaultRA, StackView.MoveAllSlicesRA, SubsampleView.SubsampleRandomAccess, TransformRandomAccess, TranslationRandomAccess, UnsafeCursor, UnsafeLocalizingCursor, UnsafeLocalizingSubIntervalCursor, UnsafeRandomAccess, UnsafeSubIntervalCursor, Volatile2DRandomAccessibleProjector, WriteConvertedCursor, WriteConvertedRandomAccess, WriteConvertedRealCursor, ZeroMinIntervalIterator
```
public interface RealLocalizable
extends EuclideanSpace
```
The RealLocalizable interface can localize itself in an n-dimensional real space.

Author:

Stephan Preibisch, Stephan Saalfeld

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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 void`	`localize(double[] position)` Write the current position into the passed array.
`default void`	`localize(float[] position)` Write the current position into the passed array.
`default void`	`localize(RealPositionable position)` Write the current position into the passed `RealPositionable`.
`default double[]`	`positionAsDoubleArray()` Allocate and return a double array with the position.
`default RealPoint`	`positionAsRealPoint()` Allocate and return a `RealPoint` with the current position.

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Method Detail
  - localize
```
default void localize(float[] position)
```
    Write the current position into the passed array.
    
    Parameters:
    
    position - receives current position
  - localize
```
default void localize(double[] position)
```
    Write the current position into the passed array.
    
    Parameters:
    
    position - receives current position
  - localize
```
default void localize(RealPositionable position)
```
    Write the current position into the passed RealPositionable. Note for developers: This default implementation forwards to RealPositionable.setPosition(RealLocalizable), so don't do the same there.
    
    Parameters:
    
    position - receives current position
  - positionAsDoubleArray
```
default double[] positionAsDoubleArray()
```
    Allocate and return a double array with the 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(double[]).
    
    Returns:
    
    the position
  - positionAsRealPoint
```
default RealPoint positionAsRealPoint()
```
    Allocate and return a RealPoint with the current position. Please note that his method allocates a new RealPoint each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated RealPoint first and reuse it with localize(RealPositionable).
    
    Returns:
    
    the position
  - getFloatPosition
```
default float getFloatPosition(int d)
```
    Return the current position in a given dimension.
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
double getDoublePosition(int d)
```
    Return the current position in a given dimension.
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position

Interface RealLocalizable

Method Summary

Methods inherited from interface net.imglib2.EuclideanSpace

Method Detail

localize

localize

localize

positionAsDoubleArray

positionAsRealPoint

getFloatPosition

getDoublePosition