public class CompositeView<T,C extends Composite<T>> extends Object implements RandomAccessible<C>, View
CompositeView
collapses the trailing dimension of a
RandomAccessible
of T into a Composite
of T. The results is
an (n-1)-dimensional RandomAccessible
of Composite
of T.Modifier and Type | Class and Description |
---|---|
class |
CompositeView.CompositeRandomAccess |
Modifier and Type | Field and Description |
---|---|
protected CompositeFactory<T,C> |
compositeFactory |
protected int |
n |
protected RandomAccessible<T> |
source |
Constructor and Description |
---|
CompositeView(RandomAccessible<T> source,
CompositeFactory<T,C> compositeFactory) |
Modifier and Type | Method and Description |
---|---|
int |
numDimensions()
Gets the space's number of dimensions.
|
CompositeView.CompositeRandomAccess |
randomAccess()
Create a random access sampler for integer coordinates.
|
CompositeView.CompositeRandomAccess |
randomAccess(Interval interval)
Create a random access sampler for integer coordinates.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAt, getAt, getAt
protected final CompositeFactory<T,C extends Composite<T>> compositeFactory
protected final RandomAccessible<T> source
protected final int n
public CompositeView(RandomAccessible<T> source, CompositeFactory<T,C> compositeFactory)
public int numDimensions()
EuclideanSpace
numDimensions
in interface EuclideanSpace
public CompositeView.CompositeRandomAccess 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.
randomAccess
in interface RandomAccessible<C extends Composite<T>>
public CompositeView.CompositeRandomAccess randomAccess(Interval interval)
RandomAccessible
The returned random access is intended to be used in the specified
interval only. Thus, the RandomAccessible may provide optimized versions.
If the interval is completely contained in the domain, the random access
is guaranteed to provide the same values as that obtained by
RandomAccessible.randomAccess()
within the interval.
randomAccess
in interface RandomAccessible<C extends Composite<T>>
interval
- in which interval you intend to use the random access.Copyright © 2015–2022 ImgLib2. All rights reserved.