Class ArrayImg<T extends NativeType<T>,A>
- java.lang.Object
-
- net.imglib2.img.AbstractImg<T>
-
- net.imglib2.img.AbstractNativeImg<T,A>
-
- net.imglib2.img.array.ArrayImg<T,A>
-
- Type Parameters:
T
-A
-
- All Implemented Interfaces:
java.lang.Iterable<T>
,Dimensions
,EuclideanSpace
,Img<T>
,NativeImg<T,A>
,Interval
,IterableInterval<T>
,IterableRealInterval<T>
,RandomAccessible<T>
,RandomAccessibleInterval<T>
,RealInterval
,SubIntervalIterable<T>
- Direct Known Subclasses:
ARGBScreenImage
,ArrayImgAWTScreenImage
public class ArrayImg<T extends NativeType<T>,A> extends AbstractNativeImg<T,A> implements SubIntervalIterable<T>
ThisImg
stores an image in a single linear array of basic types. By that, it provides the fastest possible access to data while limiting the number of basic types stored toInteger.MAX_VALUE
. Keep in mind that this does not necessarily reflect the number of pixels, because a pixel can be stored in less than or more than a basic type entry.- Author:
- Stephan Preibisch, Stephan Saalfeld
-
-
Field Summary
-
Fields inherited from class net.imglib2.img.AbstractNativeImg
entitiesPerPixel, linkedType, numEntities
-
Fields inherited from class net.imglib2.img.AbstractImg
dimension, max, n, numPixels
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ArrayImg<T,?>
copy()
ArrayCursor<T>
cursor()
Returns aRealCursor
that iterates with optimal speed without calculating the location at each iteration step.Cursor<T>
cursor(Interval interval)
ArrayImgFactory<T>
factory()
Get aImgFactory
that createsImg
s of the same kind as this one.FlatIterationOrder
iterationOrder()
Returns the iteration order of thisIterableRealInterval
.ArrayLocalizingCursor<T>
localizingCursor()
Returns aRealLocalizable
Iterator
that calculates its location at each iteration step.Cursor<T>
localizingCursor(Interval interval)
ArrayRandomAccess<T>
randomAccess()
Create a random access sampler for integer coordinates.ArrayRandomAccess<T>
randomAccess(Interval interval)
Create a random access sampler for integer coordinates.java.lang.Object
subIntervalIterationOrder(Interval interval)
Returns the iteration order given the interval.boolean
supportsOptimizedCursor(Interval interval)
A
update(java.lang.Object o)
called by type with cursor.-
Methods inherited from class net.imglib2.img.AbstractNativeImg
createLinkedType, setLinkedType
-
Methods inherited from class net.imglib2.img.AbstractImg
dimension, dimensions, firstElement, iterator, max, max, max, min, min, min, numDimensions, numElements, realMax, realMax, realMax, realMin, realMin, realMin, size, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.imglib2.Dimensions
dimension, dimensions
-
Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions
-
Methods inherited from interface net.imglib2.IterableRealInterval
firstElement, size
-
-
-
-
Method Detail
-
update
public A update(java.lang.Object o)
Description copied from interface:NativeImg
called by type with cursor.
-
cursor
public ArrayCursor<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.
- Specified by:
cursor
in interfaceIterableInterval<T extends NativeType<T>>
- Specified by:
cursor
in interfaceIterableRealInterval<T extends NativeType<T>>
- Returns:
- fast iterating iterator
-
localizingCursor
public ArrayLocalizingCursor<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.
- Specified by:
localizingCursor
in interfaceIterableInterval<T extends NativeType<T>>
- Specified by:
localizingCursor
in interfaceIterableRealInterval<T extends NativeType<T>>
- Returns:
- fast localizing iterator
-
randomAccess
public ArrayRandomAccess<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.- Specified by:
randomAccess
in interfaceRandomAccessible<T extends NativeType<T>>
- Returns:
- random access sampler
-
randomAccess
public ArrayRandomAccess<T> randomAccess(Interval interval)
Description copied from interface:RandomAccessible
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
RandomAccessible.randomAccess()
within the interval.- Specified by:
randomAccess
in interfaceRandomAccessible<T extends NativeType<T>>
- Overrides:
randomAccess
in classAbstractImg<T extends NativeType<T>>
- Parameters:
interval
- in which interval you intend to use the random access.- Returns:
- random access sampler
-
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.- Specified by:
iterationOrder
in interfaceIterableRealInterval<T extends NativeType<T>>
- Returns:
- the iteration order of this
IterableRealInterval
. - See Also:
FlatIterationOrder
-
factory
public ArrayImgFactory<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.- Specified by:
factory
in interfaceImg<T extends NativeType<T>>
- Returns:
- a factory for Imgs of the same kind as this one.
-
cursor
public Cursor<T> cursor(Interval interval)
- Specified by:
cursor
in interfaceSubIntervalIterable<T extends NativeType<T>>
- Parameters:
interval
-Interval
over which to iterate- Returns:
Cursor
-
localizingCursor
public Cursor<T> localizingCursor(Interval interval)
- Specified by:
localizingCursor
in interfaceSubIntervalIterable<T extends NativeType<T>>
- Parameters:
interval
-Interval
over which to iterate- Returns:
Cursor
-
supportsOptimizedCursor
public boolean supportsOptimizedCursor(Interval interval)
- Specified by:
supportsOptimizedCursor
in interfaceSubIntervalIterable<T extends NativeType<T>>
- Parameters:
interval
- to be checked- Returns:
- true if a
Cursor
can be optimized given theInterval
-
subIntervalIterationOrder
public java.lang.Object subIntervalIterationOrder(Interval interval)
Returns the iteration order given the interval.- Specified by:
subIntervalIterationOrder
in interfaceSubIntervalIterable<T extends NativeType<T>>
- Parameters:
interval
-Interval
over which to iterate- Returns:
- the iteration order object @see
IterableRealInterval
-
-