Class FlatCollections

java.lang.Object

net.imglib2.util.FlatCollections

public final class FlatCollections
extends Object

Utility class for wrapping ImgLib2 images as read-only Collections.

This is useful when you want to pass an ImgLib2 IterableInterval or RandomAccessibleInterval to an API that works with Java Collection objects, such as Google Guava's Quantiles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FlatCollections.CollectionFromII<T,E>	An IterableInterval expressed as a Collection.
private static class	FlatCollections.ListFromRAI<T,E>	A RandomAccessibleInterval expressed as a List.

Constructor Summary

Constructors

Constructor	Description
FlatCollections()

Method Summary

Modifier and Type	Method	Description
static Collection<BigInteger>	bigIntegerCollection(IterableInterval<? extends IntegerType<?>> image)	Wraps an IntegerType iterable image as a collection.
static List<BigInteger>	bigIntegerList(RandomAccessibleInterval<? extends IntegerType<?>> image)	Wraps a IntegerType random-accessible image as a list.
static Collection<Boolean>	booleanCollection(IterableInterval<? extends BooleanType<?>> image)	Wraps a BooleanType iterable image as a collection.
static List<Boolean>	booleanList(RandomAccessibleInterval<? extends BooleanType<?>> image)	Wraps a BooleanType random-accessible image as a list.
static <T,E> Collection<E>	collection(IterableInterval<T> image, Function<T,E> converter)	Wraps an IterableInterval as a Collection.
static Collection<Double>	doubleCollection(IterableInterval<? extends RealType<?>> image)	Wraps a RealType iterable image as a collection.
static List<Double>	doubleList(RandomAccessibleInterval<? extends RealType<?>> image)	Wraps a RealType random-accessible image as a list.
static Collection<Float>	floatCollection(IterableInterval<? extends RealType<?>> image)	Wraps a RealType iterable image as a collection.
static List<Float>	floatList(RandomAccessibleInterval<? extends RealType<?>> image)	Wraps a RealType random-accessible image as a list.
static Collection<Integer>	integerCollection(IterableInterval<? extends IntegerType<?>> image)	Wraps an IntegerType iterable image as a collection.
static List<Integer>	integerList(RandomAccessibleInterval<? extends IntegerType<?>> image)	Wraps an IntegerType random-accessible image as a list.
static <T,E> List<E>	list(RandomAccessibleInterval<T> image, Function<T,E> converter)	Wraps a RandomAccessibleInterval as a List.
static Collection<Long>	longCollection(IterableInterval<? extends IntegerType<?>> image)	Wraps an IntegerType iterable image as a collection.
static List<Long>	longList(RandomAccessibleInterval<? extends IntegerType<?>> image)	Wraps an IntegerType random-accessible image as a list.
private static int	sizeAsInt(long size)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FlatCollections

public FlatCollections()

Method Details

collection

public static <T,E> Collection<E> collection(IterableInterval<T> image,
 Function<T,E> converter)

Wraps an IterableInterval as a Collection. The wrapped collection is read-only, throwing UnsupportedOperationException if the caller attempts to mutate it.

With this method, and unlike list(RandomAccessibleInterval, Function), the iteration order of the wrapped collection will match that of the source image. It is best not to make any assumptions about the iteration order of the collection—only that each element of the wrapped image will appear once in the iteration.

Parameters:

image - The IterableInterval to wrap as a Java collection.

converter - Conversion function to use for accessing elements of the collection. This function will be transparently called on the corresponding source sample from the ImgLib2 image.

Returns:

Wrapped Collection of the converted type.

booleanCollection

public static Collection<Boolean> booleanCollection(IterableInterval<? extends BooleanType<?>> image)

Wraps a BooleanType iterable image as a collection.

Warning: Don't make any assumption on the iteration order, only that each pixel will appear once. Performance may be low as the collection uses boxed types.

Parameters:

image - The IterableInterval to wrap as a Java collection.

Returns:

Wrapped Collection with Boolean elements.

See Also:

• collection(IterableInterval, Function)

doubleCollection

public static Collection<Double> doubleCollection(IterableInterval<? extends RealType<?>> image)

Wraps a RealType iterable image as a collection.

Warning: Don't make any assumption on the iteration order, only that each pixel will appear once. Performance may be low as the collection uses boxed types.

Parameters:

image - The IterableInterval to wrap as a Java collection.

Returns:

Wrapped Collection with Double elements.

See Also:

• collection(IterableInterval, Function)

floatCollection

public static Collection<Float> floatCollection(IterableInterval<? extends RealType<?>> image)

Wraps a RealType iterable image as a collection.

Warning: Don't make any assumption on the iteration order, only that each pixel will appear once. Performance may be low as the collection uses boxed types.

Parameters:

image - The IterableInterval to wrap as a Java collection.

Returns:

Wrapped Collection with Float elements.

See Also:

• collection(IterableInterval, Function)

integerCollection

public static Collection<Integer> integerCollection(IterableInterval<? extends IntegerType<?>> image)

Wraps an IntegerType iterable image as a collection.

Warning: Don't make any assumption on the iteration order, only that each pixel will appear once. Performance may be low as the collection uses boxed types.

Parameters:

image - The IterableInterval to wrap as a Java collection.

Returns:

Wrapped Collection with Integer elements.

See Also:

• collection(IterableInterval, Function)

longCollection

public static Collection<Long> longCollection(IterableInterval<? extends IntegerType<?>> image)

Wraps an IntegerType iterable image as a collection.

Warning: Don't make any assumption on the iteration order, only that each pixel will appear once. Performance may be low as the collection uses boxed types.

Parameters:

image - The IterableInterval to wrap as a Java collection.

Returns:

Wrapped Collection with Long elements.

See Also:

• collection(IterableInterval, Function)

bigIntegerCollection

public static Collection<BigInteger> bigIntegerCollection(IterableInterval<? extends IntegerType<?>> image)

Wraps an IntegerType iterable image as a collection.

Warning: Don't make any assumption on the iteration order, only that each pixel will appear once. Performance may be low as the collection uses boxed types.

Parameters:

image - The IterableInterval to wrap as a Java collection.

Returns:

Wrapped Collection with BigInteger elements.

See Also:

• collection(IterableInterval, Function)

list

public static <T,E> List<E> list(RandomAccessibleInterval<T> image,
 Function<T,E> converter)

Wraps a RandomAccessibleInterval as a List. The wrapped list is read-only, throwing UnsupportedOperationException if the caller attempts to mutate it.

With this method, and unlike collection(IterableInterval, Function), the iteration order of the wrapped list will always be the flat iteration order, as though Views.flatIterable(RandomAccessibleInterval) were used on the source RandomAccessibleInterval image. As such, iterating the original image and the wrapped List may result in differing sequences of elements.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

converter - Conversion function to use for accessing elements of the list. This function will be transparently called on the corresponding source sample from the ImgLib2 image.

Returns:

Wrapped List of the converted type.

booleanList

public static List<Boolean> booleanList(RandomAccessibleInterval<? extends BooleanType<?>> image)

Wraps a BooleanType random-accessible image as a list.

Warning: Performance may be low, as the collection uses boxed types.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

Returns:

Wrapped List with Boolean elements.

See Also:

• list(RandomAccessibleInterval, Function)

doubleList

public static List<Double> doubleList(RandomAccessibleInterval<? extends RealType<?>> image)

Wraps a RealType random-accessible image as a list.

Warning: Performance may be low, as the collection uses boxed types.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

Returns:

Wrapped List with Double elements.

See Also:

• list(RandomAccessibleInterval, Function)

floatList

public static List<Float> floatList(RandomAccessibleInterval<? extends RealType<?>> image)

Wraps a RealType random-accessible image as a list.

Warning: Performance may be low, as the collection uses boxed types.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

Returns:

Wrapped List with Float elements.

See Also:

• list(RandomAccessibleInterval, Function)

integerList

public static List<Integer> integerList(RandomAccessibleInterval<? extends IntegerType<?>> image)

Wraps an IntegerType random-accessible image as a list.

Warning: Performance may be low, as the collection uses boxed types.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

Returns:

Wrapped List with Integer elements.

See Also:

• list(RandomAccessibleInterval, Function)

longList

public static List<Long> longList(RandomAccessibleInterval<? extends IntegerType<?>> image)

Wraps an IntegerType random-accessible image as a list.

Warning: Performance may be low, as the collection uses boxed types.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

Returns:

Wrapped List with Long elements.

See Also:

• list(RandomAccessibleInterval, Function)

bigIntegerList

public static List<BigInteger> bigIntegerList(RandomAccessibleInterval<? extends IntegerType<?>> image)

Wraps a IntegerType random-accessible image as a list.

Warning: Performance may be low, as the collection uses boxed types.

Parameters:

image - The RandomAccessibleInterval to wrap as a Java list.

Returns:

Wrapped List with BigInteger elements.

See Also:

• list(RandomAccessibleInterval, Function)

sizeAsInt

private static int sizeAsInt(long size)