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, Typed<T>, SubIntervalIterable<T>

Direct Known Subclasses:

ARGBScreenImage, ArrayImgAWTScreenImage
```
public class ArrayImg<T extends NativeType<T>,A extends DataAccess>
extends AbstractNativeImg<T,A>
implements SubIntervalIterable<T>
```
This 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.

Field Summary

Fields
Modifier and Type Field Description

private A data

(package private) int[] dim

(package private) int[] steps
- Fields inherited from class net.imglib2.img.AbstractNativeImg
  entitiesPerPixel, linkedType, numEntities
- Fields inherited from class net.imglib2.img.AbstractImg
  dimension, max, n, numPixels

Constructor Summary

Constructors
Constructor	Description
`ArrayImg(A data, long[] dim, Fraction entitiesPerPixel)`
`ArrayImg(java.lang.Object data, long[] dim, Fraction entitiesPerPixel)`	Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`	Create a `Cursor` to iterate over the given `Interval`.
`ArrayImgFactory<T>`	`factory()`	Get a `ImgFactory` that creates `Img`s of the same kind as this one.
`private int`	`fastCursorAvailable(Interval interval)`	If method returns -1 no fast cursor is available, else the amount of dims (starting from zero) which can be iterated fast are returned.
`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)`	Create a `Cursor` to iterate over the given `Interval`.
`LocalizableSpliterator<T>`	`localizingSpliterator()`	Creates a `LocalizableSpliterator` over the elements of this `IterableInterval`.
`private long`	`offset(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.
`private long`	`size(Interval interval, int length)`
`LocalizableSpliterator<T>`	`spliterator()`	Creates a `LocalizableSpliterator` over the elements of this `IterableInterval`.
`java.lang.Object`	`subIntervalIterationOrder(Interval interval)`	Returns the iteration order given the interval.
`boolean`	`supportsOptimizedCursor(Interval interval)`	Determine whether a `Cursor` can be created that iterates the given `Interval`.
`A`	`update(java.lang.Object o)`	called by type with cursor.

Methods inherited from class net.imglib2.img.AbstractNativeImg
createLinkedType, getType, setLinkedType

Methods inherited from class net.imglib2.img.AbstractImg
dimension, dimensions, 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
dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.Interval
dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface net.imglib2.IterableRealInterval
firstElement, getType, iterator, parallelStream, stream

Methods inherited from interface net.imglib2.RandomAccessible
getAt, getAt, getAt

Methods inherited from interface net.imglib2.RandomAccessibleInterval
size

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin

- Field Detail
  - steps
```
final int[] steps
```
  - dim
```
final int[] dim
```
  - data
```
private final A extends DataAccess data
```
- Constructor Detail
  - ArrayImg
```
public ArrayImg(A data,
                long[] dim,
                Fraction entitiesPerPixel)
```
  - ArrayImg
```
@Deprecated
public ArrayImg(java.lang.Object data,
                long[] dim,
                Fraction entitiesPerPixel)
```
    Deprecated.
    
    Deprecated constructor for binary compatibility when A was not bounded by DataAccess
    
    Parameters:
    
    data - - will be cast to DataAccess type A
    
    dim -
    
    entitiesPerPixel -
- Method Detail
  - update
```
public A update(java.lang.Object o)
```
    Description copied from interface: NativeImg
    
    called by type with cursor.
    
    Specified by:
    
    update in interface NativeImg<T extends NativeType<T>,A extends DataAccess>
    
    Parameters:
    
    o - cursor
    
    Returns:
    
    DataAccess which is referred to by the updater
  - 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 interface IterableInterval<T extends NativeType<T>>
    
    Specified by:
    
    cursor in interface IterableRealInterval<T extends NativeType<T>>
    
    Specified by:
    
    cursor in interface RandomAccessibleInterval<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 interface IterableInterval<T extends NativeType<T>>
    
    Specified by:
    
    localizingCursor in interface IterableRealInterval<T extends NativeType<T>>
    
    Specified by:
    
    localizingCursor in interface RandomAccessibleInterval<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: 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.
    Specified by:
    
    randomAccess in interface RandomAccessible<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 interface RandomAccessible<T extends NativeType<T>>
    
    Overrides:
    
    randomAccess in class AbstractImg<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 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.
    
    Specified by:
    
    iterationOrder in interface IterableRealInterval<T extends NativeType<T>>
    
    Specified by:
    
    iterationOrder in interface RandomAccessibleInterval<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 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.
    
    Specified by:
    
    factory in interface Img<T extends NativeType<T>>
    
    Returns:
    
    a factory for Imgs of the same kind as this one.
  - copy
```
public ArrayImg<T,?> copy()
```
    Specified by:
    
    copy in interface Img<T extends NativeType<T>>
    
    Returns:
    
    - A copy of the current Img instance, all pixels are duplicated
  - cursor
```
public Cursor<T> cursor(Interval interval)
```
    Create a Cursor to iterate over the given Interval.
    
    Specified by:
    
    cursor in interface SubIntervalIterable<T extends NativeType<T>>
    
    Parameters:
    
    interval - Interval over which to iterate
    
    Returns:
    
    Cursor
  - size
```
private long size(Interval interval,
                  int length)
```
  - offset
```
private long offset(Interval interval)
```
  - fastCursorAvailable
```
private int fastCursorAvailable(Interval interval)
```
    If method returns -1 no fast cursor is available, else the amount of dims (starting from zero) which can be iterated fast are returned.
  - localizingCursor
```
public Cursor<T> localizingCursor(Interval interval)
```
    Create a Cursor to iterate over the given Interval.
    
    Specified by:
    
    localizingCursor in interface SubIntervalIterable<T extends NativeType<T>>
    
    Parameters:
    
    interval - Interval over which to iterate
    
    Returns:
    
    Cursor
  - supportsOptimizedCursor
```
public boolean supportsOptimizedCursor(Interval interval)
```
    Determine whether a Cursor can be created that iterates the given Interval.
    
    Specified by:
    
    supportsOptimizedCursor in interface SubIntervalIterable<T extends NativeType<T>>
    
    Parameters:
    
    interval - to be checked
    
    Returns:
    
    true if a Cursor can be optimized given the Interval
  - subIntervalIterationOrder
```
public java.lang.Object subIntervalIterationOrder(Interval interval)
```
    Returns the iteration order given the interval.
    
    Specified by:
    
    subIntervalIterationOrder in interface SubIntervalIterable<T extends NativeType<T>>
    
    Parameters:
    
    interval - Interval over which to iterate
    
    Returns:
    
    the iteration order object @see IterableRealInterval
  - spliterator
```
public LocalizableSpliterator<T> spliterator()
```
    Description copied from interface: IterableInterval
    
    Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.
    The default implementation wraps a Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<T extends NativeType<T>>
    
    Specified by:
    
    spliterator in interface IterableInterval<T extends NativeType<T>>
    
    Specified by:
    
    spliterator in interface IterableRealInterval<T extends NativeType<T>>
  - localizingSpliterator
```
public LocalizableSpliterator<T> localizingSpliterator()
```
    Description copied from interface: IterableInterval
    
    Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator calculates its location at each iteration step. That is, localization is performed with optimal speed.
    The default implementation wraps a localizing Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.
    
    Specified by:
    
    localizingSpliterator in interface IterableInterval<T extends NativeType<T>>
    
    Specified by:
    
    localizingSpliterator in interface IterableRealInterval<T extends NativeType<T>>

Modifier and Type	Field	Description
`private A`	`data`
`(package private) int[]`	`dim`
`(package private) int[]`	`steps`

Class ArrayImg<T extends NativeType<T>,​A extends DataAccess>

Field Summary

Fields inherited from class net.imglib2.img.AbstractNativeImg

Fields inherited from class net.imglib2.img.AbstractImg

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.img.AbstractNativeImg

Methods inherited from class net.imglib2.img.AbstractImg

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.Dimensions

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.Interval

Methods inherited from interface java.lang.Iterable

Methods inherited from interface net.imglib2.IterableRealInterval

Methods inherited from interface net.imglib2.RandomAccessible

Methods inherited from interface net.imglib2.RandomAccessibleInterval

Methods inherited from interface net.imglib2.RealInterval

Field Detail

steps

dim

data

Constructor Detail

ArrayImg

ArrayImg

Method Detail

update

cursor

localizingCursor

randomAccess

randomAccess

iterationOrder

factory

copy

cursor

size

offset

fastCursorAvailable

localizingCursor

supportsOptimizedCursor

subIntervalIterationOrder

spliterator

localizingSpliterator

Class ArrayImg<T extends NativeType<T>,A extends DataAccess>