Package net.imglib2.img

Class ImgView<T extends Type<T>>

java.lang.Object

net.imglib2.AbstractWrappedRealInterval<I>

net.imglib2.AbstractWrappedInterval<RandomAccessibleInterval<T>>

net.imglib2.view.IterableRandomAccessibleInterval<T>

net.imglib2.img.ImgView<T>

All Implemented Interfaces:

java.lang.Iterable<T>, Dimensions, EuclideanSpace, Img<T>, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval, Typed<T>, View, SubIntervalIterable<T>

public class ImgView<T extends Type<T>>
extends IterableRandomAccessibleInterval<T>
implements Img<T>, SubIntervalIterable<T>

Allows a RandomAccessibleInterval to be treated as an Img.

Field Summary

Fields

Modifier and Type	Field	Description
private ImgFactory<T>	factory
private IterableInterval<T>	ii

Fields inherited from class net.imglib2.AbstractWrappedRealInterval

sourceInterval

Constructor Summary

Constructors

Constructor	Description
ImgView(RandomAccessibleInterval<T> in, ImgFactory<T> fac)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Img<T>	copy()
Cursor<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.
ImgFactory<T>	factory()	Get a ImgFactory that creates Imgs of the same kind as this one.
Cursor<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.
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.
static <T extends Type<T>> Img<T>	wrap(RandomAccessibleInterval<T> accessible)	Represent an arbitrary RandomAccessibleInterval as an Img, with a suitable ImgFactory for its size and type, created by Util.getSuitableImgFactory(net.imglib2.Dimensions, Object).
static <T extends Type<T>> Img<T>	wrap(RandomAccessibleInterval<T> accessible, ImgFactory<T> factory)	Represent an arbitrary RandomAccessibleInterval as an Img.

Methods inherited from class net.imglib2.view.IterableRandomAccessibleInterval

create, getType, iterationOrder, randomAccess, randomAccess, size

Methods inherited from class net.imglib2.AbstractWrappedInterval

dimension, dimensions, max, max, max, min, min, min

Methods inherited from class net.imglib2.AbstractWrappedRealInterval

getSource, numDimensions, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.IterableInterval

localizingSpliterator, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, getType, iterator, parallelStream, stream

Methods inherited from interface net.imglib2.RandomAccessible

getAt, getAt, getAt, randomAccess, randomAccess

Methods inherited from interface net.imglib2.RandomAccessibleInterval

iterationOrder, size

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin

Field Detail

factory

private final ImgFactory<T extends Type<T>> factory

ii

private final IterableInterval<T extends Type<T>> ii

Constructor Detail

ImgView

@Deprecated
public ImgView(RandomAccessibleInterval<T> in,
               ImgFactory<T> fac)

Deprecated.

View on Img which is defined by a given Interval, but still is an Img. Deprecation: Use wrap(RandomAccessibleInterval, ImgFactory) to represent a RandomAccessibleInterval as an Img

Parameters:

in - Source interval for the view

fac - T Factory to create img

Method Detail

factory

public ImgFactory<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 Type<T>>

Returns:

a factory for Imgs of the same kind as this one.

copy

public Img<T> copy()

Specified by:

copy in interface Img<T extends Type<T>>

Returns:

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

cursor

public Cursor<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 Type<T>>

Specified by:

cursor in interface IterableRealInterval<T extends Type<T>>

Specified by:

cursor in interface RandomAccessibleInterval<T extends Type<T>>

Overrides:

cursor in class IterableRandomAccessibleInterval<T extends Type<T>>

Returns:

fast iterating iterator

localizingCursor

public Cursor<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 Type<T>>

Specified by:

localizingCursor in interface IterableRealInterval<T extends Type<T>>

Specified by:

localizingCursor in interface RandomAccessibleInterval<T extends Type<T>>

Overrides:

localizingCursor in class IterableRandomAccessibleInterval<T extends Type<T>>

Returns:

fast localizing iterator

supportsOptimizedCursor

public boolean supportsOptimizedCursor(Interval interval)

Description copied from interface: SubIntervalIterable

Determine whether a Cursor can be created that iterates the given Interval.

Specified by:

supportsOptimizedCursor in interface SubIntervalIterable<T extends Type<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)

Description copied from interface: SubIntervalIterable

Returns the iteration order given the interval.

Specified by:

subIntervalIterationOrder in interface SubIntervalIterable<T extends Type<T>>

Parameters:

interval - Interval over which to iterate

Returns:

the iteration order object @see IterableRealInterval

cursor

public Cursor<T> cursor(Interval interval)

Description copied from interface: SubIntervalIterable

Create a Cursor to iterate over the given Interval.

Specified by:

cursor in interface SubIntervalIterable<T extends Type<T>>

Parameters:

interval - Interval over which to iterate

Returns:

Cursor

localizingCursor

public Cursor<T> localizingCursor(Interval interval)

Description copied from interface: SubIntervalIterable

Create a Cursor to iterate over the given Interval.

Specified by:

localizingCursor in interface SubIntervalIterable<T extends Type<T>>

Parameters:

interval - Interval over which to iterate

Returns:

Cursor

wrap

public static <T extends Type<T>> Img<T> wrap(RandomAccessibleInterval<T> accessible)

Represent an arbitrary RandomAccessibleInterval as an Img, with a suitable ImgFactory for its size and type, created by Util.getSuitableImgFactory(net.imglib2.Dimensions, Object).

Parameters:

accessible - RandomAccessibleInterval which will be wrapped with an ImgView

Returns:

RandomAccessibleInterval represented as an Img

See Also:

Util.getSuitableImgFactory(net.imglib2.Dimensions, Object)

wrap

public static <T extends Type<T>> Img<T> wrap(RandomAccessibleInterval<T> accessible,
                                              ImgFactory<T> factory)

Represent an arbitrary RandomAccessibleInterval as an Img.

Parameters:

accessible - RandomAccessibleInterval which will be wrapped with an ImgView

factory - ImgFactory returned by factory()

Returns:

RandomAccessibleInterval represented as an Img