net.imglib2.converter.read

Class ConvertedRandomAccessible<A,B>

java.lang.Object

net.imglib2.converter.AbstractConvertedRandomAccessible<A,B>

net.imglib2.converter.read.ConvertedRandomAccessible<A,B>

All Implemented Interfaces:

EuclideanSpace, RandomAccessible<B>, Typed<B>, View

public class ConvertedRandomAccessible<A,B>
extends AbstractConvertedRandomAccessible<A,B>

TODO

Field Summary

Fields

Modifier and Type	Field and Description
protected Supplier<? extends B>	convertedSupplier
protected Supplier<Converter<? super A,? super B>>	converterSupplier

Fields inherited from class net.imglib2.converter.AbstractConvertedRandomAccessible

source

Constructor Summary

Constructors

Constructor and Description
ConvertedRandomAccessible(RandomAccessible<A> source, Converter<? super A,? super B> converter, Supplier<B> convertedSupplier)
ConvertedRandomAccessible(RandomAccessible<A> source, Supplier<Converter<? super A,? super B>> converterSupplier, Supplier<? extends B> convertedSupplier)

Method Summary

Modifier and Type	Method and Description
Converter<? super A,? super B>	getConverter() Deprecated. Use getConverterSupplier() instead
Supplier<Converter<? super A,? super B>>	getConverterSupplier()
Supplier<? extends B>	getDestinationSupplier()
B	getDestinationType() Deprecated. Use getDestinationSupplier() instead.
B	getType() Get an instance of T.
ConvertedRandomAccess<A,B>	randomAccess() Create a random access sampler for integer coordinates.
ConvertedRandomAccess<A,B>	randomAccess(Interval interval) Create a random access sampler for integer coordinates.

Methods inherited from class net.imglib2.converter.AbstractConvertedRandomAccessible

getSource, numDimensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.RandomAccessible

getAt, getAt, getAt

Field Detail

converterSupplier

protected final Supplier<Converter<? super A,? super B>> converterSupplier

convertedSupplier

protected final Supplier<? extends B> convertedSupplier

Constructor Detail

ConvertedRandomAccessible

public ConvertedRandomAccessible(RandomAccessible<A> source,
                                 Supplier<Converter<? super A,? super B>> converterSupplier,
                                 Supplier<? extends B> convertedSupplier)

ConvertedRandomAccessible

public ConvertedRandomAccessible(RandomAccessible<A> source,
                                 Converter<? super A,? super B> converter,
                                 Supplier<B> convertedSupplier)

Method Detail

randomAccess

public ConvertedRandomAccess<A,B> 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: RandomAccessibleIntervals 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.

Specified by:

randomAccess in interface RandomAccessible<B>

Specified by:

randomAccess in class AbstractConvertedRandomAccessible<A,B>

Returns:

random access sampler

randomAccess

public ConvertedRandomAccess<A,B> randomAccess(Interval interval)

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 interface RandomAccessible<B>

Specified by:

randomAccess in class AbstractConvertedRandomAccessible<A,B>

Parameters:

interval - in which interval you intend to use the random access.

Returns:

random access sampler

getDestinationType

@Deprecated
public B getDestinationType()

Deprecated. Use getDestinationSupplier() instead.

Returns:

an instance of the destination Type.

getDestinationSupplier

public Supplier<? extends B> getDestinationSupplier()

Returns:

the supplier of conversion destination instances

getType

public B getType()

Description copied from interface: Typed

Get an instance of T.

It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

Returns:

an instance of T

getConverter

@Deprecated
public Converter<? super A,? super B> getConverter()

Deprecated. Use getConverterSupplier() instead

Returns an instance of the Converter. If the ConvertedRandomAccessible was created with a Converter instead of a Supplier, then the returned converter will be this instance.

Returns:

getConverterSupplier

public Supplier<Converter<? super A,? super B>> getConverterSupplier()

Returns:

the supplier of converter instances