O
- The RealType
.public class IterableRandomAccessibleFunction<C extends RealType<C>,O extends RealType<O>> extends AbstractInterval implements RandomAccessibleInterval<O>, IterableInterval<O>, View
View
of the computation defined by an IFunction
.
The dimensions are those of the first input RandomAccessibleInterval
found.
(the computation will fail if images do not have the same dimensions.)
If an output type is not defined, then the RealType
of the first RandomAccessibleInterval
found is used.Modifier and Type | Field and Description |
---|---|
protected C |
computeType |
protected Converter<RealType<?>,C> |
inConverter |
protected IFunction |
operation |
protected Converter<C,O> |
outConverter |
protected O |
outputType |
max, min
n
Constructor and Description |
---|
IterableRandomAccessibleFunction(IFunction operation)
Use a the same
RealType as the first input RandomAccessibleInterval found,
and a default Converter as defined by Util.genericRealTypeConverter() . |
IterableRandomAccessibleFunction(IFunction operation,
Converter<RealType<?>,C> inConverter,
C computeType,
O outputType,
Converter<C,O> outConverter) |
IterableRandomAccessibleFunction(IFunction operation,
O outputType)
Use a default
Converter as defined by Util.genericRealTypeConverter() . |
IterableRandomAccessibleFunction(IFunction operation,
O outputType,
Converter<C,O> outConverter)
Use a default
Converter as defined by Util.genericRealTypeConverter() . |
Modifier and Type | Method and Description |
---|---|
Cursor<O> |
cursor()
Returns a
RealCursor that iterates with optimal speed without
calculating the location at each iteration step. |
O |
firstElement()
Get the first element of this
IterableRealInterval . |
Object |
iterationOrder()
Returns the iteration order of this
IterableRealInterval . |
Iterator<O> |
iterator() |
Cursor<O> |
localizingCursor()
Returns a
RealLocalizable Iterator that calculates its
location at each iteration step. |
RandomAccess<O> |
randomAccess()
Create a random access sampler for integer coordinates.
|
RandomAccess<O> |
randomAccess(Interval interval)
Create a random access sampler for integer coordinates.
|
long |
size()
Returns the number of elements in this
Function . |
dimension, dimensions, max, max, max, min, min, min, realMax, realMax, realMax, realMin, realMin, realMin, toString
numDimensions
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAt, getAt, getAt
forEach, 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 IFunction operation
public IterableRandomAccessibleFunction(IFunction operation, Converter<RealType<?>,C> inConverter, C computeType, O outputType, Converter<C,O> outConverter)
operation
- inConverter
- Can be nullcomputeType
- outputType
- outConverter
- Can be null.public IterableRandomAccessibleFunction(IFunction operation, O outputType)
Converter
as defined by Util.genericRealTypeConverter()
.public IterableRandomAccessibleFunction(IFunction operation, O outputType, Converter<C,O> outConverter)
Converter
as defined by Util.genericRealTypeConverter()
.public IterableRandomAccessibleFunction(IFunction operation)
RealType
as the first input RandomAccessibleInterval
found,
and a default Converter
as defined by Util.genericRealTypeConverter()
.public RandomAccess<O> 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<O extends RealType<O>>
public RandomAccess<O> 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<O extends RealType<O>>
interval
- in which interval you intend to use the random access.public O firstElement()
IterableRealInterval
IterableRealInterval
. This is a
shortcut for cursor().next()
.
This can be used to create a new variable of type T using
firstElement().createVariable()
, which is useful in generic
methods to store temporary results, e.g., a running sum over pixels in
the IterableRealInterval
.firstElement
in interface IterableRealInterval<O extends RealType<O>>
public Object 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.iterationOrder
in interface IterableRealInterval<O extends RealType<O>>
IterableRealInterval
.FlatIterationOrder
public long size()
IterableRealInterval
Returns the number of elements in this Function
.
size
in interface IterableRealInterval<O extends RealType<O>>
public Cursor<O> 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.
cursor
in interface IterableInterval<O extends RealType<O>>
cursor
in interface IterableRealInterval<O extends RealType<O>>
public Cursor<O> 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.
localizingCursor
in interface IterableInterval<O extends RealType<O>>
localizingCursor
in interface IterableRealInterval<O extends RealType<O>>
Copyright © 2015–2022 ImgLib2. All rights reserved.