Interface RealLocalizable

All Superinterfaces:
EuclideanSpace
All Known Subinterfaces:
Cursor<T>, Localizable, LocalizableSampler<T>, LocalizableSpliterator<T>, OutOfBounds<T>, RandomAccess<T>, RealCursor<T>, RealLocalizableSampler<T>, RealLocalizableSpliterator<T>, RealOutOfBounds<T>, RealRandomAccess<T>
All Known Implementing Classes:
AbstractArrayCursor, AbstractArrayLocalizingCursor, AbstractConvertedCursor, AbstractConvertedRandomAccess, AbstractConvertedRealCursor, AbstractConvertedRealRandomAccess, AbstractCursor, AbstractCursorInt, AbstractLocalizable, AbstractLocalizableInt, AbstractLocalizingCursor, AbstractLocalizingCursorInt, AbstractLongListImg.LongListCursor, AbstractLongListImg.LongListLocalizingCursor, AbstractLongListImg.LongListRandomAccess, AbstractOutOfBoundsMirror, AbstractOutOfBoundsValue, AbstractPositionableTransform, AbstractProjector2D, AbstractRealLocalizable, AbstractWrappedLocalizable, AbstractWrappedPositionableLocalizable, ArrayCursor, ArrayImgXYByteProjector, ArrayImgXYShortProjector, ArrayLocalizingCursor, ArrayLocalizingSpliterator, ArrayLocalizingSubIntervalCursor, ArrayRandomAccess, ArraySpliterator, ArraySubIntervalCursor, BiConvertedCursor, BiConvertedRandomAccess, BiConvertedRealCursor, BiConvertedRealRandomAccess, BundleView.BundleRandomAccess, CellCursor, CellGrid.CellIntervalsRA, CellLocalizingCursor, CellRandomAccess, CellSpliterator, ClampingNLinearInterpolatorRealType, ClampingNLinearInterpolatorVolatileARGB, ClampingNLinearInterpolatorVolatileRealType, CompositeView.CompositeRandomAccess, CompositeXYProjector, CompositeXYRandomAccessibleProjector, ConvertedCursor, ConvertedRandomAccess, ConvertedRealCursor, ConvertedRealRandomAccess, CursorSpliterator, Floor, FloorInterpolator, FloorOffset, FullSourceMapMixedRandomAccess, FullSourceMapSlicingRandomAccess, FunctionRandomAccessible.FunctionRandomAccess, FunctionRealRandomAccessible.RealFunctionRealRandomAccess, FunctionView.FunctionRandomAccess, Grid.CellIntervalsRA, HyperSlice.HyperSliceRandomAccess, HyperSlicesView.HyperSlicesViewRandomAccess, InflateView.InflateRandomAccess, InterleaveView.InterleaveRandomAccess, IntervalIterator, InverseDistanceWeightingInterpolator, IterableIntervalProjector2D, KDTree.KDTreeCursor, KDTreeNode, LanczosInterpolator, LinearRealRandomAccessibleStackInterpolator, ListCursor, ListLocalizingCursor, ListRandomAccess, Localizables.LocationRandomAccess, Localizables.RealLocationRealRandomAccess, LocalizableSamplerWrapper, LocalizingIntervalIterator, LocalizingRealIntervalIterator, LocalizingZeroMinIntervalIterator, MixedRandomAccess, NearestNeighborInterpolator, NearestNeighborRealRandomAccessibleStackInterpolator, NearestNeighborSearchInterpolator, NLinearInterpolator, NLinearInterpolator1D, NLinearInterpolator2D, NLinearInterpolator3D, NLinearInterpolatorARGB, NtreeCursor, NtreeRandomAccess, OffsetableIntervalIterator, OffsetableLocalizingIntervalIterator, OutOfBoundsBorder, OutOfBoundsConstantValue, OutOfBoundsMirrorDoubleBoundary, OutOfBoundsMirrorExpWindowing, OutOfBoundsMirrorSingleBoundary, OutOfBoundsPeriodic, OutOfBoundsRandomValue, PlanarCursor, PlanarCursor1D, PlanarCursor2D, PlanarImgXYByteProjector, PlanarImgXYShortProjector, PlanarLocalizingCursor, PlanarLocalizingCursor1D, PlanarLocalizingCursor2D, PlanarPlaneSubsetCursor, PlanarPlaneSubsetLocalizingCursor, PlanarRandomAccess, PlanarRandomAccess1D, PlanarSpliterator, Point, PointSample, PointSampleList.PointSampleListCursor, PositionRandomAccessible.PositionRandomAccess, RandomAccessibleIntervalCursor, RandomAccessibleOnRealRandomAccessible.RandomAccessOnRealRandomAccessible, RandomAccessiblePair.RandomAccess, RandomAccessibleProjector2D, RealComposite, RealCursorSpliterator, RealLocalizableSamplerWrapper, RealOutOfBoundsRealRandomAccess, RealPoint, RealPointSample, RealPointSampleList.RealPointSampleListCursor, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, Round, SamplingProjector2D, SlicingCursor, SlicingRandomAccess, StackView.DefaultRA, StackView.MoveAllSlicesRA, SubsampleView.SubsampleRandomAccess, TransformRandomAccess, TranslationRandomAccess, Volatile2DRandomAccessibleProjector, WriteConvertedCursor, WriteConvertedRandomAccess, WriteConvertedRealCursor, ZeroMinIntervalIterator
public interface RealLocalizable extends EuclideanSpace
The RealLocalizable interface can localize itself in an n-dimensional real space.

  • Method Details

    • localize

      default void localize(float[] position)
      Write the current position into the passed array.
      Parameters:
      position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

    • localize

      default void localize(double[] position)
      Write the current position into the passed array.
      Parameters:
      position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

    • localize

      default void localize(RealPositionable position)
      Write the current position into the passed Positionable. Note for developers: This default implementation forwards to RealPositionable.setPosition(RealLocalizable), so don't do the same there.
      Parameters:
      position - receives current position EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

    • 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