Package net.imglib2.img.cell
Class AbstractCellImg<T extends NativeType<T>,A,C extends Cell<A>,I extends RandomAccessible<C> & IterableInterval<C>>
java.lang.Object
net.imglib2.img.AbstractImg<T>
net.imglib2.img.AbstractNativeImg<T,A>
net.imglib2.img.cell.AbstractCellImg<T,A,C,I>
- All Implemented Interfaces:
Iterable<T>
,Dimensions
,EuclideanSpace
,Img<T>
,NativeImg<T,
,A> Interval
,IterableInterval<T>
,IterableRealInterval<T>
,RandomAccessible<T>
,RandomAccessibleInterval<T>
,RealInterval
- Direct Known Subclasses:
CellImg
,LazyCellImg
public abstract class AbstractCellImg<T extends NativeType<T>,A,C extends Cell<A>,I extends RandomAccessible<C> & IterableInterval<C>>
extends AbstractNativeImg<T,A>
Abstract superclass for
Img
types that divide their underlying data
into cells.- Author:
- Mark Hiner, Tobias Pietzsch
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
This interface is implemented by all samplers on theAbstractCellImg
. -
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionprotected void
copyDataTo
(AbstractCellImg<T, ?, ?, ?> copy) CellCursor
<T, C> cursor()
Returns aRealCursor
that iterates with optimal speed without calculating the location at each iteration step.Get theCellGrid
which describes the layout of theAbstractCellImg
.getCells()
Get the underlying image of cells which gives access to the individualCell
s through Cursors and RandomAccesses.Returns the iteration order of thisIterableRealInterval
.Returns aRealLocalizable
Iterator
that calculates its location at each iteration step.Create a random access sampler for integer coordinates.called by type with cursor.Methods inherited from class net.imglib2.img.AbstractNativeImg
createLinkedType, setLinkedType
Methods inherited from class net.imglib2.img.AbstractImg
dimension, dimensions, firstElement, iterator, 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.Dimensions
dimension, dimensions
Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
Methods inherited from interface net.imglib2.IterableRealInterval
firstElement, size
Methods inherited from interface net.imglib2.RandomAccessible
randomAccess
-
Field Details
-
grid
-
cells
-
-
Constructor Details
-
AbstractCellImg
-
-
Method Details
-
update
Description copied from interface:NativeImg
called by type with cursor.- Parameters:
cursor
- cursor- Returns:
- native array which is referred to by the updater
-
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.
- Returns:
- fast iterating iterator
-
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.
- Returns:
- fast localizing iterator
-
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:RandomAccessibleInterval
s have a finite domain (theirInterval
), soRandomAccessible.randomAccess()
is only guaranteed to cover this finite domain. This may lead to unexpected results when usingViews
. In the following codeRandomAccessible<T> extended = Views.extendBorder( img ) RandomAccessibleInterval<T> cropped = Views.interval( extended, img ); RandomAccess<T> a1 = extended.randomAccess(); RandomAccess<T> a2 = cropped.randomAccess();
Theaccess
a1
on the extended image is valid everywhere. However, somewhat counter-intuitively, theaccess
a2
on the extended and cropped image is only valid on the intervalimg
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 theRandomAccessibleInterval
, and you know that theRandomAccessibleInterval
is actually defined beyond its interval boundaries, then use theRandomAccessible.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.- Returns:
- random access sampler
-
iterationOrder
Description copied from interface:IterableRealInterval
Returns the iteration order of thisIterableRealInterval
. If the returned object equals (Object.equals(Object)
) the iteration order of anotherIterableRealInterval
f then they can be copied by synchronous iteration. That is, having anIterator
on this and anotherIterator
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.- Returns:
- the iteration order of this
IterableRealInterval
. - See Also:
-
getCells
Get the underlying image of cells which gives access to the individualCell
s through Cursors and RandomAccesses.- Returns:
- the image of cells.
-
getCellGrid
Get theCellGrid
which describes the layout of theAbstractCellImg
. The grid provides the dimensions of the image, the number of cells in each dimension, and the dimensions of individual cells.- Returns:
- the cell grid layout.
-
copyDataTo
-