public abstract class AbstractCellImg<T extends NativeType<T>,A,C extends Cell<A>,I extends RandomAccessible<C> & IterableInterval<C>> extends AbstractNativeImg<T,A>
Img
types that divide their underlying data
into cells.Modifier and Type | Class and Description |
---|---|
static interface |
AbstractCellImg.CellImgSampler<C>
This interface is implemented by all samplers on the
AbstractCellImg . |
Modifier and Type | Field and Description |
---|---|
protected I |
cells |
protected CellGrid |
grid |
entitiesPerPixel, linkedType, numEntities
dimension, max, n, numPixels
Constructor and Description |
---|
AbstractCellImg(CellGrid grid,
I imgOfCells,
Fraction entitiesPerPixel) |
Modifier and Type | Method and Description |
---|---|
protected void |
copyDataTo(AbstractCellImg<T,?,?,?> copy) |
CellCursor<T,C> |
cursor()
Returns a
RealCursor that iterates with optimal speed without
calculating the location at each iteration step. |
CellGrid |
getCellGrid()
Get the
CellGrid which describes the layout of the
AbstractCellImg . |
I |
getCells()
Get the underlying image of cells which gives access to the individual
Cell s through Cursors and RandomAccesses. |
CellIterationOrder |
iterationOrder()
Returns the iteration order of this
IterableRealInterval . |
CellLocalizingCursor<T,C> |
localizingCursor()
Returns a
RealLocalizable Iterator that calculates its
location at each iteration step. |
CellRandomAccess<T,C> |
randomAccess()
Create a random access sampler for integer coordinates.
|
A |
update(Object cursor)
called by type with cursor.
|
createLinkedType, setLinkedType
dimension, dimensions, firstElement, iterator, max, max, max, min, min, min, numDimensions, numElements, randomAccess, realMax, realMax, realMax, realMin, realMin, realMin, size, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAt, getAt, getAt, randomAccess
firstElement, size
forEach, iterator, spliterator
dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin
allPositive, allPositive, dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive
numDimensions
protected final CellGrid grid
protected final I extends RandomAccessible<C> & IterableInterval<C> cells
public A update(Object cursor)
NativeImg
cursor
- cursorpublic CellCursor<T,C> cursor()
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.
public CellLocalizingCursor<T,C> localizingCursor()
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.
public CellRandomAccess<T,C> randomAccess()
RandomAccessible
The returned random access covers as much of the domain as possible.
Please note:RandomAccessibleInterval
s 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.
public CellIterationOrder iterationOrder()
IterableRealInterval
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.IterableRealInterval
.FlatIterationOrder
public I getCells()
Cell
s through Cursors and RandomAccesses.public CellGrid getCellGrid()
CellGrid
which describes the layout of the
AbstractCellImg
. The grid provides the dimensions of the image, the
number of cells in each dimension, and the dimensions of individual
cells.protected void copyDataTo(AbstractCellImg<T,?,?,?> copy)
Copyright © 2015–2022 ImgLib2. All rights reserved.