T
- A
- public class ArrayImg<T extends NativeType<T>,A> extends AbstractNativeImg<T,A> implements SubIntervalIterable<T>
Img
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 to Integer.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.entitiesPerPixel, linkedType, numEntities
dimension, max, n, numPixels
Constructor and Description |
---|
ArrayImg(A data,
long[] dim,
Fraction entitiesPerPixel) |
Modifier and Type | Method and Description |
---|---|
ArrayImg<T,?> |
copy() |
ArrayCursor<T> |
cursor()
Returns a
RealCursor that iterates with optimal speed without
calculating the location at each iteration step. |
Cursor<T> |
cursor(Interval interval)
|
ArrayImgFactory<T> |
factory()
Get a
ImgFactory that creates Img s of the same kind as
this one. |
FlatIterationOrder |
iterationOrder()
Returns the iteration order of this
IterableRealInterval . |
ArrayLocalizingCursor<T> |
localizingCursor()
Returns a
RealLocalizable 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.
|
Object |
subIntervalIterationOrder(Interval interval)
Returns the iteration order given the interval.
|
boolean |
supportsOptimizedCursor(Interval interval)
|
A |
update(Object o)
called by type with cursor.
|
createLinkedType, setLinkedType
dimension, dimensions, firstElement, iterator, max, max, max, min, min, min, numDimensions, numElements, realMax, realMax, realMax, realMin, realMin, realMin, size, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAt, getAt, getAt
firstElement, size
forEach, iterator, spliterator
dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin
allPositive, allPositive, dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive
numDimensions
public A update(Object o)
NativeImg
public ArrayCursor<T> cursor()
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.
cursor
in interface IterableInterval<T extends NativeType<T>>
cursor
in interface IterableRealInterval<T extends NativeType<T>>
public ArrayLocalizingCursor<T> localizingCursor()
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.
localizingCursor
in interface IterableInterval<T extends NativeType<T>>
localizingCursor
in interface IterableRealInterval<T extends NativeType<T>>
public ArrayRandomAccess<T> randomAccess()
RandomAccessible
The returned random access covers as much of the domain as possible.
Please note:RandomAccessibleInterval
s 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.
randomAccess
in interface RandomAccessible<T extends NativeType<T>>
public ArrayRandomAccess<T> randomAccess(Interval interval)
RandomAccessible
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.
randomAccess
in interface RandomAccessible<T extends NativeType<T>>
randomAccess
in class AbstractImg<T extends NativeType<T>>
interval
- in which interval you intend to use the random access.public FlatIterationOrder iterationOrder()
IterableRealInterval
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.iterationOrder
in interface IterableRealInterval<T extends NativeType<T>>
IterableRealInterval
.FlatIterationOrder
public ArrayImgFactory<T> factory()
Img
ImgFactory
that creates Img
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.factory
in interface Img<T extends NativeType<T>>
public Cursor<T> cursor(Interval interval)
cursor
in interface SubIntervalIterable<T extends NativeType<T>>
interval
- Interval
over which to iterateCursor
public Cursor<T> localizingCursor(Interval interval)
localizingCursor
in interface SubIntervalIterable<T extends NativeType<T>>
interval
- Interval
over which to iterateCursor
public boolean supportsOptimizedCursor(Interval interval)
supportsOptimizedCursor
in interface SubIntervalIterable<T extends NativeType<T>>
interval
- to be checkedCursor
can be optimized given the
Interval
public Object subIntervalIterationOrder(Interval interval)
subIntervalIterationOrder
in interface SubIntervalIterable<T extends NativeType<T>>
interval
- Interval
over which to iterateIterableRealInterval
Copyright © 2015–2022 ImgLib2. All rights reserved.