Package net.imglib2.img.sparse
Class NtreeImg<T extends NativeType<T>,A extends NtreeAccess<?,A>>
- java.lang.Object
-
- net.imglib2.img.AbstractImg<T>
-
- net.imglib2.img.AbstractNativeImg<T,A>
-
- net.imglib2.img.sparse.NtreeImg<T,A>
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Iterable<T>,Dimensions,EuclideanSpace,Img<T>,NativeImg<T,A>,Interval,IterableInterval<T>,IterableRealInterval<T>,RandomAccessible<T>,RandomAccessibleInterval<T>,RealInterval,Typed<T>
public final class NtreeImg<T extends NativeType<T>,A extends NtreeAccess<?,A>> extends AbstractNativeImg<T,A> implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceNtreeImg.PositionProvider
-
Field Summary
Fields Modifier and Type Field Description (package private) Adataprivate static longserialVersionUIDTODO: remove with proper serialization-
Fields inherited from class net.imglib2.img.AbstractNativeImg
entitiesPerPixel, linkedType, numEntities
-
Fields inherited from class net.imglib2.img.AbstractImg
dimension, max, n, numPixels
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NtreeImg<T,A>copy()NtreeCursor<T>cursor()Returns aRealCursorthat iterates with optimal speed without calculating the location at each iteration step.ImgFactory<T>factory()Get aImgFactorythat createsImgs of the same kind as this one.FlatIterationOrderiterationOrder()Returns the iteration order of thisIterableRealInterval.NtreeCursor<T>localizingCursor()Returns aRealLocalizableIteratorthat calculates its location at each iteration step.NtreeRandomAccess<T>randomAccess()Create a random access sampler for integer coordinates.Aupdate(java.lang.Object updater)called by type with cursor.-
Methods inherited from class net.imglib2.img.AbstractNativeImg
createLinkedType, getType, setLinkedType
-
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.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 net.imglib2.IterableInterval
localizingSpliterator, spliterator
-
Methods inherited from interface net.imglib2.IterableRealInterval
firstElement, iterator, parallelStream, stream
-
Methods inherited from interface net.imglib2.RandomAccessible
getAt, getAt, getAt, randomAccess
-
Methods inherited from interface net.imglib2.RandomAccessibleInterval
size
-
Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
TODO: remove with proper serialization- See Also:
- Constant Field Values
-
data
final A extends NtreeAccess<?,A> data
-
-
Method Detail
-
update
public A update(java.lang.Object updater)
Description copied from interface:NativeImgcalled by type with cursor.- Specified by:
updatein interfaceNativeImg<T extends NativeType<T>,A extends NtreeAccess<?,A>>- Parameters:
updater- cursor- Returns:
DataAccesswhich is referred to by the updater
-
randomAccess
public NtreeRandomAccess<T> randomAccess()
Description copied from interface:RandomAccessibleCreate a random access sampler for integer coordinates.The returned random access covers as much of the domain as possible.
Please note:RandomAccessibleIntervals 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();
Theaccessa1on the extended image is valid everywhere. However, somewhat counter-intuitively, theaccessa2on the extended and cropped image is only valid on the intervalimgto which the extended image was cropped. The access is only required to cover this interval, because it is the domain of the cropped image.Viewsattempts 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 theRandomAccessibleIntervalis 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.- Specified by:
randomAccessin interfaceRandomAccessible<T extends NativeType<T>>- Returns:
- random access sampler
-
cursor
public NtreeCursor<T> cursor()
Description copied from interface:IterableRealIntervalReturns a
RealCursorthat 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:
cursorin interfaceIterableInterval<T extends NativeType<T>>- Specified by:
cursorin interfaceIterableRealInterval<T extends NativeType<T>>- Specified by:
cursorin interfaceRandomAccessibleInterval<T extends NativeType<T>>- Returns:
- fast iterating iterator
-
localizingCursor
public NtreeCursor<T> localizingCursor()
Description copied from interface:IterableRealIntervalReturns a
RealLocalizableIteratorthat 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:
localizingCursorin interfaceIterableInterval<T extends NativeType<T>>- Specified by:
localizingCursorin interfaceIterableRealInterval<T extends NativeType<T>>- Specified by:
localizingCursorin interfaceRandomAccessibleInterval<T extends NativeType<T>>- Returns:
- fast localizing iterator
-
factory
public ImgFactory<T> factory()
Description copied from interface:ImgGet aImgFactorythat createsImgs 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:
factoryin interfaceImg<T extends NativeType<T>>- Returns:
- a factory for Imgs of the same kind as this one.
-
iterationOrder
public FlatIterationOrder iterationOrder()
Description copied from interface:IterableRealIntervalReturns the iteration order of thisIterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of anotherIterableRealIntervalf then they can be copied by synchronous iteration. That is, having anIteratoron this and anotherIteratoron 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.- Specified by:
iterationOrderin interfaceIterableRealInterval<T extends NativeType<T>>- Specified by:
iterationOrderin interfaceRandomAccessibleInterval<T extends NativeType<T>>- Returns:
- the iteration order of this
IterableRealInterval. - See Also:
FlatIterationOrder
-
-