Test ImgLib2 descriptor extensibility

gselzer · gselzer · commit fb8feb3a934c · 2024-03-20T13:10:22.000-05:00
diff --git a/scijava-ops-image/src/main/java/org/scijava/ops/image/describe/ImgLib2Descriptors.java b/scijava-ops-image/src/main/java/org/scijava/ops/image/describe/ImgLib2Descriptors.java
@@ -12,50 +12,71 @@
 
 import java.util.function.Function;
 
-public class ImgLib2Descriptors< //
-		A, //
-		C extends ComplexType<C>, //
-		I extends IntegerType<I>, //
-		T extends RealType<T> //
-> {
+/**
+ * {@code engine.describe} Ops pertaining to ImgLib2 types.
+ * <p>
+ * Note that each input is a {@code Nil<T>}, where {@code T} is a type variable
+ * bounded by the type we actually want to describe. This provides
+ * extensibility, as it allows e.g. {@link #raiDesc(Nil)} to be used for e.g.
+ * {@link net.imglib2.img.array.ArrayImg}s
+ * </p>
+ *
+ * @author Gabriel Selzer
+ */
+public class ImgLib2Descriptors {
 
 	/**
-	 * @input the type to describe
-	 * @output the description
+	 * @param in the type to describe
+	 * @return the description
 	 * @implNote op name="engine.describe"
 	 */
-	public final Function<Nil<IterableInterval<A>>, String> iiDesc = //
-		in -> "image";
+	public static <A, T extends IterableInterval<A>> String iiDesc( //
+		Nil<T> in //
+	) {
+		return "image";
+	}
 
 	/**
-	 * @input the type to describe
-	 * @output the description
-	 * @implNote op name="engine.describe", priority="100."
+	 * @param in the type to describe
+	 * @return the description
+	 * @implNote op name="engine.describe", priority='100.'
 	 */
-	public final Function<Nil<RandomAccessibleInterval<A>>, String> raiDesc = //
-		in -> "image";
+	public static <A, T extends RandomAccessibleInterval<A>> String raiDesc( //
+		Nil<T> in //
+	) {
+		return "image";
+	}
 
 	/**
-	 * @input the type to describe
-	 * @output the description
-	 * @implNote op name="engine.describe", priority="1000."
+	 * @param in the type to describe
+	 * @return the description
+	 * @implNote op name="engine.describe", priority='10000.'
 	 */
-	public final Function<Nil<ImgLabeling<A, I>>, String> imgLabelDesc = //
-		in -> "labels";
+	public static <A, I extends IntegerType<I>, T extends ImgLabeling<A, I>>
+		String labelDesc(Nil<T> in)
+	{
+		return "labels";
+	}
 
 	/**
-	 * @input the type to describe
-	 * @output the description
+	 * @param in the type to describe
+	 * @return the description
 	 * @implNote op name="engine.describe", priority='100.'
 	 */
-	public final Function<Nil<T>, String> realTypeDesc = //
-		in -> "number";
+	public static <T extends RealType<T>> String realTypeDesc( //
+		Nil<T> in //
+	) {
+		return "number";
+	}
 
 	/**
-	 * @input the type to describe
-	 * @output the description
+	 * @param in the type to describe
+	 * @return the description
 	 * @implNote op name="engine.describe"
 	 */
-	public final Function<Nil<C>, String> complexTypeDesc = //
-		in -> "complex number";
+	public static <T extends ComplexType<T>> String complexTypeDesc( //
+		Nil<T> in //
+	) {
+		return "complex number";
+	}
 }
diff --git a/scijava-ops-image/src/test/java/org/scijava/ops/image/OpRegressionTest.java b/scijava-ops-image/src/test/java/org/scijava/ops/image/OpRegressionTest.java
@@ -42,7 +42,7 @@ public class OpRegressionTest {
 
 	@Test
 	public void opDiscoveryRegressionIT() {
-		long expected = 1922;
+		long expected = 1923;
 		long actual = ops.infos().size();
 		assertEquals(expected, actual);
 	}
diff --git a/scijava-ops-image/src/test/java/org/scijava/ops/image/describe/ImgLib2DescriptorsTest.java b/scijava-ops-image/src/test/java/org/scijava/ops/image/describe/ImgLib2DescriptorsTest.java
@@ -3,16 +3,27 @@
 
 import net.imglib2.IterableInterval;
 import net.imglib2.RandomAccessibleInterval;
+import net.imglib2.img.array.ArrayImg;
+import net.imglib2.img.basictypeaccess.DataAccess;
 import net.imglib2.loops.LoopBuilder;
 import net.imglib2.roi.labeling.ImgLabeling;
+import net.imglib2.type.NativeType;
 import net.imglib2.type.numeric.ComplexType;
 import net.imglib2.type.numeric.IntegerType;
 import net.imglib2.type.numeric.RealType;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.scijava.ops.image.AbstractOpTest;
+import org.scijava.types.Types;
 
-public class DescriptorsTest extends AbstractOpTest {
+import java.lang.reflect.ParameterizedType;
+
+/**
+ * Tests {@link ImgLib2Descriptors}.
+ *
+ * @author Gabriel Selzer
+ */
+public class ImgLib2DescriptorsTest extends AbstractOpTest {
 
 	/**
 	 * @implNote op name=example.describeRealType, type=Inplace
@@ -95,4 +106,33 @@ public void testImgLabelingDescription() {
 		Assertions.assertEquals(expected, actual);
 	}
 
+	/**
+	 * @implNote op name=example.describeArrayImg, type=Inplace
+	 */
+	public static <T extends NativeType<T>, A extends DataAccess> void
+		randomAccessibleInterval(ArrayImg<T, A> in)
+	{}
+
+	/**
+	 * This test ensures description extensibility for ImgLib2 image types
+	 */
+	@Test
+	public void testArrayImgDescription() {
+		// First, ensure there is no descriptor FOR ArrayImgs
+		for (var info : ops.infos("engine.describe")) {
+			var in = info.inputTypes().get(0);
+			Assertions.assertInstanceOf(ParameterizedType.class, in);
+			var descriptorType = ((ParameterizedType) in).getActualTypeArguments()[0];
+			Assertions.assertFalse( //
+				Types.isAssignable(descriptorType, ArrayImg.class) //
+			);
+		}
+
+		// Then, ensure that we get a description anyways
+		var expected = "example.describeArrayImg:\n" +
+			"\t- (@MUTABLE image) -> None";
+		var actual = ops.help("example.describeArrayImg");
+		Assertions.assertEquals(expected, actual);
+	}
+
 }

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public class OpRegressionTest {`
`42`	`42`
`43`	`43`	`@Test`
`44`	`44`	`public void opDiscoveryRegressionIT() {`
`45`		`- long expected = 1922;`
	`45`	`+ long expected = 1923;`
`46`	`46`	`long actual = ops.infos().size();`
`47`	`47`	`assertEquals(expected, actual);`
`48`	`48`	`}`