Package net.imglib2.view
Class SubsampleView<T>
java.lang.Object
net.imglib2.view.SubsampleView<T>
- All Implemented Interfaces:
EuclideanSpace
,RandomAccessible<T>
,View
- Direct Known Subclasses:
SubsampleIntervalView
SubsampleView
is a view that provides access to only every
sdth value of a source
RandomAccessible
. This is effectively an integer scaling
transformation. Localization calls to the RandomAccess
return scaled
coordinates that are generated on-the-fly. Localization is thus moderately
inefficient to the benefit of faster positioning. Don't ask for what you
already know ;).- Author:
- Stephan Saalfeld
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionSubsampleView
(RandomAccessible<T> source, long step) SubsampleView
(RandomAccessible<T> source, long... steps) -
Method Summary
Modifier and TypeMethodDescriptionlong[]
getSteps()
int
Gets the space's number of dimensions.Create a random access sampler for integer coordinates.randomAccess
(Interval interval) Create a random access sampler for integer coordinates.
-
Field Details
-
source
-
steps
protected final long[] steps
-
-
Constructor Details
-
SubsampleView
-
SubsampleView
-
-
Method Details
-
numDimensions
public int numDimensions()Description copied from interface:EuclideanSpace
Gets the space's number of dimensions.- Specified by:
numDimensions
in interfaceEuclideanSpace
-
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.- Specified by:
randomAccess
in interfaceRandomAccessible<T>
- Returns:
- random access sampler
-
randomAccess
Description copied from interface:RandomAccessible
Create a random access sampler for integer coordinates.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.- Specified by:
randomAccess
in interfaceRandomAccessible<T>
- Parameters:
interval
- in which interval you intend to use the random access.- Returns:
- random access sampler
-
getSource
-
getSteps
public long[] getSteps()- Returns:
- sub-sampling steps
-