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 usType
s or arbitraryObject
s. If you use non-Type
pixels, note, that you cannot useType.set(Type)
to change the value stored in every reference. Instead, you can use theListCursor.set(Object)
andListRandomAccess.set(Object)
methods to alter pixels.
- All Implemented Interfaces:
java.lang.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 forImg
that store pixels in a single linear array (anArrayList
or similar).In principle, the number of entities stored is limited toInteger.MAX_VALUE
. Derived classes need to implement theget(int)
andset(int, Object)
methods that are used by accessors to access pixels. These could be implemented to fetch pixels from anArrayList
, create them on the fly, cache to disk, etc.- Author:
- Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractListImg(long[] dim)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ListCursor<T>
cursor()
Returns aRealCursor
that iterates with optimal speed without calculating the location at each iteration step.ListImgFactory<T>
factory()
Get aImgFactory
that createsImg
s of the same kind as this one.protected abstract T
get(int index)
FlatIterationOrder
iterationOrder()
Returns the iteration order of thisIterableRealInterval
.ListLocalizingCursor<T>
localizingCursor()
Returns aRealLocalizable
Iterator
that calculates its location at each iteration step.ListRandomAccess<T>
randomAccess()
Create a random access sampler for integer coordinates.protected abstract void
set(int index, T value)
-
Methods inherited from class net.imglib2.img.AbstractImg
dimension, dimensions, firstElement, iterator, max, max, max, min, min, min, numDimensions, numElements, randomAccess, realMax, realMax, realMax, realMin, realMin, realMin, size, toString
-
-
-
-
Method Detail
-
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:RandomAccessibleInterval
s have a finite domain (theirInterval
), soRandomAccessible.randomAccess()
is only guaranteed to cover this finite domain. This may lead to unexpected results when usingViews
. In the following codeRandomAccessible<T> extended = Views.extendBorder( img ) RandomAccessibleInterval<T> cropped = Views.interval( extended, img ); RandomAccess<T> a1 = extended.randomAccess(); RandomAccess<T> a2 = cropped.randomAccess();
Theaccess
a1
on the extended image is valid everywhere. However, somewhat counter-intuitively, theaccess
a2
on the extended and cropped image is only valid on the intervalimg
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 theRandomAccessibleInterval
, and you know that theRandomAccessibleInterval
is actually defined beyond its interval boundaries, then use theRandomAccessible.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 aImgFactory
that createsImg
s 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 thisIterableRealInterval
. If the returned object equals (Object.equals(Object)
) the iteration order of anotherIterableRealInterval
f then they can be copied by synchronous iteration. That is, having anIterator
on this and anotherIterator
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:
FlatIterationOrder
-
-