RandomAccessible (ImgLib2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

EuclideanSpace

All Known Subinterfaces:

Img<T>, IterableRegion<T>, Labeling<T>, NativeImg<T,A>, NativeLabeling<T>, NativeLongAccessImg<T,A>, PositionableIterableRegion<T>, RandomAccessibleInterval<T>, TransformedRandomAccessible<T>

All Known Implementing Classes:

AbstractCellImg, AbstractConvertedIterableRandomAccessibleInterval, AbstractConvertedRandomAccessible, AbstractConvertedRandomAccessibleInterval, AbstractImg, AbstractLabeling, AbstractListImg, AbstractLongListImg, AbstractNativeImg, AbstractNativeLabeling, AbstractNativeLongAccessImg, AffineRandomAccessible, ARGBScreenImage, ArrayImg, ArrayImgAWTScreenImage, BiConvertedRandomAccessible, BiConvertedRandomAccessibleInterval, Boundary, ByteAWTScreenImage, ByteImagePlus, CachedCellImg, CellImg, CompositeIntervalView, CompositeView, ConvertedRandomAccessible, ConvertedRandomAccessibleInterval, DiamondShape.NeighborhoodsAccessible, DiamondTipsShape.NeighborhoodsAccessible, DiscreteFrequencyDistribution, DiskCachedCellImg, DoubleAWTScreenImage, ExtendedRandomAccessibleInterval, FloatAWTScreenImage, FloatImagePlus, FunctionRandomAccessible, Histogram1d, HistogramNd, HorizontalLineShape.NeighborhoodsAccessible, HyperSlice, HyperSlicesView, HyperSphereShape.NeighborhoodsAccessible, ImagePlusImg, ImgLabeling, ImgView, IntAWTScreenImage, IntervalView, IntImagePlus, IterableRandomAccessibleFunction, IterableRandomAccessibleFunctionDouble, IterableRandomAccessibleInterval, IterableRandomAccessibleRegion, IterableRegionOnBooleanRAI, KDTreeRadiusSource, LabelingView, LabelRegion, LazyCellImg, LazyCellImg.LazyCells, ListImg, MaskAsRandomAccessible, MaskIntervalAsRandomAccessibleInterval, MixedTransformView, NativeImgLabeling, NtreeImg, PairOfPointsShape.NeighborhoodsAccessible, PeriodicLineShape.NeighborhoodsAccessible, PlanarImg, PositionableWrappedIterableRegion, PositionRandomAccessible, PositionRandomAccessible, RandomAccessibleOnRealRandomAccessible, RandomAccessiblePair, RealTransformRandomAccessible, RectangleShape.NeighborhoodsAccessible, ScaleAsFunctionOfPosition, ShortAWTScreenImage, ShortImagePlus, SingleCellArrayImg, StackView, SubsampleIntervalView, SubsampleView, TransformView, UnsafeImg, UnsignedByteAWTScreenImage, UnsignedIntAWTScreenImage, UnsignedShortAWTScreenImage, VolumetricSearch, WriteConvertedIterableRandomAccessibleInterval, WriteConvertedRandomAccessible, WriteConvertedRandomAccessibleInterval
```
public interface RandomAccessible<T>
extends EuclideanSpace
```
f:Zⁿ→T

A function over integer space that can create a random access Sampler.

If your algorithm takes a RandomAccessible, this usually means that you expect that the domain is infinite. (In contrast to this, RandomAccessibleIntervals have a finite domain.)

A RandomAccessible might be defined only partially. You should be aware of this especially when creating RandomAccessibleIntervals. While it is straightforward to turn a RandomAccessible into a RandomAccessibleInterval by adding interval boundaries via Views.interval(net.imglib2.RandomAccessible<T>, long[], long[]), it is your responsibility to ensure that the RandomAccessible is fully defined within these boundaries.

Author:

Stephan Saalfeld, Tobias Pietzsch

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default T`	`getAt(int... position)` Convenience method to query a `RandomAccessible` for the value at a position.
`default T`	`getAt(Localizable position)` Convenience method to query a `RandomAccessible` for the value at a position.
`default T`	`getAt(long... position)` Convenience method to query a `RandomAccessible` for the value at a position.
`RandomAccess<T>`	`randomAccess()` Create a random access sampler for integer coordinates.
`RandomAccess<T>`	`randomAccess(Interval interval)` Create a random access sampler for integer coordinates.

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Method Detail
  - randomAccess
```
RandomAccess<T> randomAccess()
```
    Create a random access sampler for integer coordinates.
    The returned random access covers as much of the domain as possible.
    Please note: RandomAccessibleIntervals have a finite domain (their Interval), so randomAccess() is only guaranteed to cover this finite domain. This may lead to unexpected results when using Views. In the following code
```
 RandomAccessible<T> extended = Views.extendBorder( img )
 RandomAccessibleInterval<T> cropped = Views.interval( extended, img );
 RandomAccess<T> a1 = extended.randomAccess();
 RandomAccess<T> a2 = cropped.randomAccess();
 
```
    The access a1 on the extended image is valid everywhere. However, somewhat counter-intuitively, the access a2 on the extended and cropped image is only valid on the interval img to which the extended image was cropped. The access is only required to cover this interval, because it is the domain of the cropped image. Views attempts to provide the fastest possible access that meets this requirement, and will therefore strip the extension. To deal with this, if you know that you need to access pixels outside the domain of the RandomAccessibleInterval, and you know that the RandomAccessibleInterval is actually defined beyond its interval boundaries, then use the randomAccess(Interval) variant and specify which interval you actually want to access. In the above example,
```
 RandomAccess<T> a2 = cropped.randomAccess( Intervals.expand( img, 10 ) );
 
```
    will provide the extended access as expected.
    Returns:
    
    random access sampler
  - randomAccess
```
RandomAccess<T> randomAccess(Interval interval)
```
    Create a random access sampler for integer coordinates.
    The returned random access is intended to be used in the specified interval only. Thus, the RandomAccessible may provide optimized versions. If the interval is completely contained in the domain, the random access is guaranteed to provide the same values as that obtained by randomAccess() within the interval.
    
    Parameters:
    
    interval - in which interval you intend to use the random access.
    
    Returns:
    
    random access sampler
  - getAt
```
default T getAt(long... position)
```
    Convenience method to query a RandomAccessible for the value at a position.
    WARNING: This method is VERY SLOW, and memory inefficient when used in tight loops, or called many times!!! Use randomAccess() when efficiency is important.
    This method is a short cut for randomAccess().setPositionAndGet( position );
    
    Parameters:
    
    position -
    
    Returns:
    
    value of the the RandomAccessible at position.
  - getAt
```
default T getAt(int... position)
```
    Convenience method to query a RandomAccessible for the value at a position.
    WARNING: This method is VERY SLOW, and memory inefficient when used in tight loops, or called many times!!! Use randomAccess() when efficiency is important.
    This method is a short cut for randomAccess().setPositionAndGet( position );
    
    Parameters:
    
    position -
    
    Returns:
    
    value of the the RandomAccessible at position.
  - getAt
```
default T getAt(Localizable position)
```
    Convenience method to query a RandomAccessible for the value at a position.
    WARNING: This method is VERY SLOW, and memory inefficient when used in tight loops, or called many times!!! Use randomAccess() when efficiency is important.
    This method is a short cut for randomAccess().setPositionAndGet( position );
    
    Parameters:
    
    position -
    
    Returns:
    
    value of the the RandomAccessible at position.

Interface RandomAccessible<T>

Method Summary

Methods inherited from interface net.imglib2.EuclideanSpace

Method Detail

randomAccess

randomAccess

getAt

getAt

getAt