Package net.imglib2.loops

Class IterableLoopBuilder<T>

java.lang.Object

net.imglib2.loops.IterableLoopBuilder<T>

public class IterableLoopBuilder<T>
extends Object

Similar to LoopBuilder, but expects the first image to be an IterableInterval and the other images to be RandomAccessible.

Please note: It is usually preferable to use LoopBuilder as it often has a better performance, and using RandomAccessibleInterval for all images is simpler.

Here is an usage example, that calculates the sum of two images:

 
 IterableInterval<DoubleType> sum = ...
 RandomAccessible<DoubleType> imageA = ...
 RandomAccessible<DoubleType> imageB = ...

 IterableLoopBuilder.setImages(sum, imageA, imageB).forEachPixel(
     (s, a, b) -> {
          s.setReal(a.getRealDouble() + b.getRealDouble());
     }
 );
 
 

See Also:

• LoopBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	IterableLoopBuilder.Chunk<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final IterableInterval<?>	firstImage
private final List<RandomAccessible<?>>	otherImages
private TaskExecutor	taskExecutor

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IterableLoopBuilder(IterableInterval<?> firstImage, RandomAccessible<?>... otherImages)

Method Summary

Modifier and Type	Method	Description
<R> List<R>	forEachChunk(Function<LoopBuilder.Chunk<T>,R> chunkAction)
void	forEachPixel(T action)	Executes the given action pixel wise for the given images.
IterableLoopBuilder<T>	multithreaded()	This will cause the loop to be executed in a multi threaded fashion.
IterableLoopBuilder<T>	multithreaded(TaskExecutor taskExecutor)	This will cause the loop to be executed in a multi threaded fashion.
static <A> IterableLoopBuilder<Consumer<A>>	setImages(IterableInterval<A> a)	Set the image to loop over.
static <A, B> IterableLoopBuilder<BiConsumer<A,B>>	setImages(IterableInterval<A> a, RandomAccessible<B> b)	Sets the images to loop over.
static <A, B, C> IterableLoopBuilder<LoopBuilder.TriConsumer<A,B,C>>	setImages(IterableInterval<A> a, RandomAccessible<B> b, RandomAccessible<C> c)	Sets the images to loop over.

Methods inherited from class java.lang.Object

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

Field Details

taskExecutor

private TaskExecutor taskExecutor

firstImage

private final IterableInterval<?> firstImage

otherImages

private final List<RandomAccessible<?>> otherImages

Constructor Details

IterableLoopBuilder

private IterableLoopBuilder(IterableInterval<?> firstImage,
 RandomAccessible<?>... otherImages)

Method Details

setImages

public static <A> IterableLoopBuilder<Consumer<A>> setImages(IterableInterval<A> a)

Set the image to loop over.

setImages

public static <A,
B>
IterableLoopBuilder<BiConsumer<A,B>> setImages(IterableInterval<A> a,
 RandomAccessible<B> b)

Sets the images to loop over.

setImages

public static <A,
B,
C>
IterableLoopBuilder<LoopBuilder.TriConsumer<A,B,C>> setImages(IterableInterval<A> a,
 RandomAccessible<B> b,
 RandomAccessible<C> c)

Sets the images to loop over.

forEachPixel

public void forEachPixel(T action)

Executes the given action pixel wise for the given images.

forEachChunk

public <R> List<R> forEachChunk(Function<LoopBuilder.Chunk<T>,R> chunkAction)

See Also:

• LoopBuilder.forEachChunk(java.util.function.Function<net.imglib2.loops.LoopBuilder.Chunk<T>, R>)

multithreaded

public IterableLoopBuilder<T> multithreaded()

This will cause the loop to be executed in a multi threaded fashion. Details can be set using the Parallelization framework.

multithreaded

public IterableLoopBuilder<T> multithreaded(TaskExecutor taskExecutor)

This will cause the loop to be executed in a multi threaded fashion. The give TaskExecutor will be used for multi threading.