net.imglib2.img.list

Class ListImg<T>

java.lang.Object

net.imglib2.img.AbstractImg<T>

net.imglib2.img.list.AbstractListImg<T>

net.imglib2.img.list.ListImg<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 the underlying ArrayList.

All Implemented Interfaces:

Iterable<T>, Dimensions, EuclideanSpace, Img<T>, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval, Typed<T>

public class ListImg<T>
extends AbstractListImg<T>

This Img stores an image in a single linear ArrayList. Each pixel is stored as an individual object, so ListImg should only be used for images with relatively few pixels. In principle, the number of entities stored is limited to Integer.MAX_VALUE.

Author:

Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields inherited from class net.imglib2.img.list.AbstractListImg

dim, step

Fields inherited from class net.imglib2.img.AbstractImg

dimension, max, n, numPixels

Constructor Summary

Constructors

Constructor and Description
ListImg(Collection<T> collection, long... dim)
ListImg(long[] dim, T type)
ListImg(T type, Collection<T> collection, long... dim)

Method Summary

Modifier and Type	Method and Description
ListImg<T>	copy()
protected T	get(int index)
T	getType() Get an instance of T.
protected void	set(int index, T value)
static <T> ListImg<T>	wrap(List<T> pixels, long... dim)

Methods inherited from class net.imglib2.img.list.AbstractListImg

cursor, factory, iterationOrder, localizingCursor, randomAccess

Methods inherited from class net.imglib2.img.AbstractImg

dimension, dimensions, max, max, max, min, min, min, numDimensions, numElements, randomAccess, 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.RandomAccessible

getAt, getAt, getAt

Methods inherited from interface net.imglib2.IterableInterval

localizingSpliterator, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, iterator, parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.imglib2.Interval

maxAsLongArray, maxAsPoint, minAsLongArray, minAsPoint

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Methods inherited from interface net.imglib2.Dimensions

allPositive, allPositive, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

Constructor Detail

ListImg

public ListImg(long[] dim,
               T type)

ListImg

public ListImg(T type,
               Collection<T> collection,
               long... dim)

ListImg

public ListImg(Collection<T> collection,
               long... dim)

Method Detail

get

protected T get(int index)

Specified by:

get in class AbstractListImg<T>

getType

public T getType()

Description copied from interface: IterableRealInterval

Get an instance of T.

It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

The default implementation returns IterableRealInterval.firstElement(). Derived classes may choose different implementations for improved performance.

Returns:

an instance of T

set

protected void set(int index,
                   T value)

Specified by:

set in class AbstractListImg<T>

copy

public ListImg<T> copy()

Returns:

- A copy of the current Img instance, all pixels are duplicated

wrap

public static <T> ListImg<T> wrap(List<T> pixels,
                                  long... dim)