Opify fill package

Author: gselzer

src/main/java/net/imglib2/algorithm/fill/FloodFill.java

@@ -34,15 +34,13 @@
 
 package net.imglib2.algorithm.fill;
 
+import java.util.concurrent.ExecutorService;
 import java.util.function.BiPredicate;
 import java.util.function.Consumer;
 
 import gnu.trove.list.TLongList;
 import gnu.trove.list.array.TLongArrayList;
-import net.imglib2.Cursor;
-import net.imglib2.Localizable;
-import net.imglib2.RandomAccess;
-import net.imglib2.RandomAccessible;
+import net.imglib2.*;
 import net.imglib2.algorithm.neighborhood.Neighborhood;
 import net.imglib2.algorithm.neighborhood.Shape;
 import net.imglib2.type.Type;
@@ -105,6 +103,53 @@ public static < T extends Type< T >, U extends Type< U > > void fill(
 		fill( source, target, seed, fillLabel, shape, filter );
 	}
 
+	/**
+	 * Iterative n-dimensional flood fill for arbitrary neighborhoods: Starting
+	 * at seed location, write fillLabel into target at current location and
+	 * continue for each pixel in neighborhood defined by shape if neighborhood
+	 * pixel is in the same connected component and fillLabel has not been
+	 * written into that location yet.
+	 *
+	 * Convenience call to
+	 * {@link #fill(RandomAccessible, RandomAccessible, Localizable, Type, Shape, BiPredicate)}.
+	 * seedLabel is extracted from source at seed location.
+	 * <p>
+	 * This method differs from
+	 * {@link #fill(RandomAccessible, RandomAccessible, Localizable, Type, Shape)}
+	 * only in that its parameter order is tailored to an Op. The output comes
+	 * last, and the primary input (the input image) comes first.
+	 * </p>
+	 *
+	 * @implNote op name='floodFill', type='org.scijava.function.Computers.Arity4'
+	 * @param source
+	 *            input
+	 * @param seed
+	 *            Start flood fill at this location.
+	 * @param fillLabel
+	 *            Immutable. Value to be written into valid flood fill
+	 *            locations.
+	 * @param shape
+	 *            Defines neighborhood that is considered for connected
+	 *            components, e.g.
+	 *            {@link net.imglib2.algorithm.neighborhood.DiamondShape}
+	 * @param target
+	 *            {@link RandomAccessible} to be written into. May be the same
+	 *            as input.
+	 * @param <T>
+	 *            input pixel type
+	 * @param <U>
+	 *            fill label type
+	 */
+	public static < T extends Type< T >, U extends Type< U > > void fill(
+			final RandomAccessible< T > source,
+			final Localizable seed,
+			final U fillLabel,
+			final Shape shape,
+			final RandomAccessible< U > target)
+	{
+		fill(source, target, seed, fillLabel, shape);
+	}
+
 	/**
 	 * Iterative n-dimensional flood fill for arbitrary neighborhoods: Starting
 	 * at seed location, write fillLabel into target at current location and
@@ -150,6 +195,58 @@ public static < T, U extends Type< U > > void fill(
 		fill( source, target, seed, shape, filter, targetPixel -> targetPixel.set( fillLabel ) );
 	}
 
+	/**
+	 * Iterative n-dimensional flood fill for arbitrary neighborhoods: Starting
+	 * at seed location, write fillLabel into target at current location and
+	 * continue for each pixel in neighborhood defined by shape if neighborhood
+	 * pixel is in the same connected component and fillLabel has not been
+	 * written into that location yet.
+	 *
+	 * Convenience call to
+	 * {@link FloodFill#fill(RandomAccessible, RandomAccessible, Localizable, Shape, BiPredicate, Consumer)}
+	 * with {@link Type#set} as writer.
+	 * <p>
+	 * This method differs from
+	 * {@link #fill(RandomAccessible, RandomAccessible, Localizable, Type, Shape, BiPredicate)}
+	 * only in that its parameter order is tailored to an Op. The output comes
+	 * last, and the primary input (the input image) comes first.
+	 * </p>
+	 *
+	 * @implNote op name='floodFill', type='org.scijava.function.Computers.Arity5'
+	 * @param source
+	 *            input
+	 * @param seed
+	 *            Start flood fill at this location.
+	 * @param fillLabel
+	 *            Immutable. Value to be written into valid flood fill
+	 *            locations.
+	 * @param shape
+	 *            Defines neighborhood that is considered for connected
+	 *            components, e.g.
+	 *            {@link net.imglib2.algorithm.neighborhood.DiamondShape}
+	 * @param filter
+	 *            Returns true if pixel has not been visited yet and should be
+	 *            written into. Returns false if target pixel has been visited
+	 *            or source pixel is not part of the same connected component.
+	 * @param target
+	 *            {@link RandomAccessible} to be written into. May be the same
+	 *            as input.
+	 * @param <T>
+	 *            input pixel type
+	 * @param <U>
+	 *            fill label type
+	 */
+	public static < T, U extends Type< U > > void fill(
+			final RandomAccessible< T > source,
+			final Localizable seed,
+			final U fillLabel,
+			final Shape shape,
+			final BiPredicate< T, U > filter,
+			final RandomAccessible< U > target)
+	{
+		fill( source, target, seed, shape, filter, targetPixel -> targetPixel.set( fillLabel ) );
+	}
+
 	/**
 	 *
 	 * Iterative n-dimensional flood fill for arbitrary neighborhoods: Starting
@@ -236,6 +333,54 @@ public static < T, U > void fill(
 		}
 
 	}
+	/**
+	 *
+	 * Iterative n-dimensional flood fill for arbitrary neighborhoods: Starting
+	 * at seed location, write fillLabel into target at current location and
+	 * continue for each pixel in neighborhood defined by shape if neighborhood
+	 * pixel is in the same connected component and fillLabel has not been
+	 * written into that location yet.
+	 * <p>
+	 * This method differs from
+	 * {@link #fill(RandomAccessible, RandomAccessible, Localizable, Shape, BiPredicate, Consumer)}
+	 * only in that its parameter order is tailored to an Op. The output comes
+	 * last, and the primary input (the input image) comes first.
+	 * </p>
+	 *
+	 * @implNote op name='floodFill', type='org.scijava.function.Computers.Arity5'
+	 * @param source
+	 *            input
+	 * @param seed
+	 *            Start flood fill at this location.
+	 * @param shape
+	 *            Defines neighborhood that is considered for connected
+	 *            components, e.g.
+	 *            {@link net.imglib2.algorithm.neighborhood.DiamondShape}
+	 * @param filter
+	 *            Returns true if pixel has not been visited yet and should be
+	 *            written into. Returns false if target pixel has been visited
+	 *            or source pixel is not part of the same connected component.
+	 * @param writer
+	 *            Defines how fill label is written into target at current
+	 *            location.
+	 * @param target
+	 *            {@link RandomAccessible} to be written into. May be the same
+	 *            as input.
+	 * @param <T>
+	 *            input pixel type
+	 * @param <U>
+	 *            fill label type
+	 */
+	public static < T, U > void fill(
+			final RandomAccessible< T > source,
+			final Localizable seed,
+			final Shape shape,
+			final BiPredicate< T, U > filter,
+			final Consumer< U > writer,
+			final RandomAccessible< U > target )
+	{
+		fill(source, target, seed, shape, filter, writer);
+	}
 
 	/**
 	 * Iterative n-dimensional flood fill for arbitrary neighborhoods: Starting