Package net.imglib2.img.list

Class AbstractListImg<T>

java.lang.Object
net.imglib2.img.AbstractImg<T>
net.imglib2.img.list.AbstractListImg<T>
Type Parameters:
T - The value type of the pixels. You can us Types or arbitrary Objects. If you use non-Type pixels, note, that you cannot use Type.set(Type) to change the value stored in every reference. Instead, you can use the ListCursor.set(Object) and ListRandomAccess.set(Object) methods to alter pixels.
All Implemented Interfaces:
Iterable<T>, Dimensions, EuclideanSpace, Img<T>, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval
Direct Known Subclasses:
ListImg
public abstract class AbstractListImg<T> extends AbstractImg<T>
Abstract base class for Img that store pixels in a single linear array (an ArrayList or similar).In principle, the number of entities stored is limited to Integer.MAX_VALUE. Derived classes need to implement the get(int) and set(int, Object) methods that are used by accessors to access pixels. These could be implemented to fetch pixels from an ArrayList, create them on the fly, cache to disk, etc.
Author:
Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

  • Field Details

    • step

      protected final int[] step

    • dim

      protected final int[] dim

  • Constructor Details

    • AbstractListImg

      protected AbstractListImg(long[] dim)

  • Method Details

    • get

      protected abstract T get(int index)

    • set

      protected abstract void set(int index, T value)

    • cursor

      public ListCursor<T> cursor()
      Description copied from interface: IterableRealInterval

      Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

      Use this where localization is required rarely/ not for each iteration.

      Returns:
      fast iterating iterator

    • localizingCursor

      public ListLocalizingCursor<T> localizingCursor()
      Description copied from interface: IterableRealInterval

      Returns a RealLocalizable Iterator that calculates its location at each iteration step. That is, localization is performed with optimal speed.

      Use this where localization is required often/ for each iteration.

      Returns:
      fast localizing iterator

    • randomAccess

      public ListRandomAccess<T> randomAccess()
      Description copied from interface: RandomAccessible
      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 RandomAccessible.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 RandomAccessible.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

    • factory

      public ListImgFactory<T> factory()
      Description copied from interface: Img
      Get a ImgFactory that creates Imgs of the same kind as this one. This is useful to create Imgs for temporary storage in generic methods where the specific Img type is unknown. Note, that the factory can be used even if all references to this Img have been invalidated.
      Returns:
      a factory for Imgs of the same kind as this one.

    • iterationOrder

      public FlatIterationOrder iterationOrder()
      Description copied from interface: IterableRealInterval
      Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.
      Returns:
      the iteration order of this IterableRealInterval.
      See Also: