Let "Open Current OME-Zarr Image in BigDataViewer" also open several OME-Zarr images at once.

The command previously opened only the active OME-Zarr. With more than one open, in ImageJ or BDV, it now asks which to show, via OmeZarrImagesChooser, and
shows them in one new BDV window, like BigDataViewer's own "Open Current Image" does.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Author: stefanhahmann

ome-zarr-fiji-ui/src/main/java/ome/zarr/fijiui/plugin/command/tools/OpenInBDVCommand.java

@@ -29,6 +29,8 @@
 package ome.zarr.fijiui.plugin.command.tools;
 
 import java.lang.invoke.MethodHandles;
+import java.util.Collections;
+import java.util.List;
 
 import org.scijava.command.Command;
 import org.scijava.plugin.Parameter;
@@ -43,7 +45,9 @@
 import ome.zarr.fiji.PyramidalBdv;
 import ome.zarr.fiji.plugins.PyramidalService;
 import ome.zarr.fiji.util.BdvUtils;
+import ome.zarr.fiji.util.OmeZarrImagesChooser;
 import ome.zarr.fijiui.open.OmeZarrDropListener;
+import ome.zarr.imglib2.PyramidContents;
 
 @Plugin( type = Command.class, menuPath = "Plugins > OME-Zarr > Open Current OME-Zarr Image in BigDataViewer" )
 public class OpenInBDVCommand implements Command
@@ -72,8 +76,25 @@ public void run()
 				logger.warn( message );
 			return;
 		}
-		final PyramidalBdv< ? > pyramidalBdv = new PyramidalBdv<>( this.pyramidal.getContext(), this.pyramidal.getPyramidContents() );
-		final BdvHandle bdvHandle = BdvUtils.show( pyramidalBdv, pyramidalService );
-		OmeZarrDropListener.install( bdvHandle, this.pyramidal.getContext() );
+		BdvHandle bdvHandle = null;
+		for ( final PyramidContents< ? > selected : selectContents() )
+			bdvHandle = BdvUtils.show( new PyramidalBdv<>( this.pyramidal.getContext(), selected ), bdvHandle, pyramidalService );
+		if ( bdvHandle != null )
+			OmeZarrDropListener.install( bdvHandle, this.pyramidal.getContext() );
+	}
+
+	/**
+	 * The OME-Zarrs to show in one BDV window: just the active one, unless more than one
+	 * is open, in ImageJ or BigDataViewer. Each is listed once, however many windows show it.
+	 */
+	private List< PyramidContents< ? > > selectContents()
+	{
+		final List< PyramidContents< ? > > open = pyramidalService.getPyramidContents();
+		if ( open.isEmpty() )
+			return Collections.emptyList();
+		// for one OME-Zarr, this.pyramidal's contents should be the same as open.get( 0 )
+		if ( open.size() == 1 || uiService.isHeadless() )
+			return Collections.singletonList( this.pyramidal.getPyramidContents() );
+		return OmeZarrImagesChooser.choose( open, this.pyramidal.getPyramidContents() ); // NB: the active one is pre-selected
 	}
 }

ome-zarr-fiji-ui/src/test/java/ome/zarr/fijiui/plugin/command/tools/OpenInBDVCommandTest.java

@@ -6,13 +6,13 @@
  * %%
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
- * 
+ *
  * 1. Redistributions of source code must retain the above copyright notice,
  *    this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -32,13 +32,21 @@
 import static org.junit.jupiter.api.Assertions.assertNotSame;
 import static org.junit.jupiter.api.Assertions.assertSame;
 
+import java.awt.AWTEvent;
+import java.awt.Toolkit;
 import java.awt.Window;
+import java.awt.event.AWTEventListener;
+import java.awt.event.WindowEvent;
 import java.lang.reflect.InvocationTargetException;
 import java.net.URISyntaxException;
 import java.nio.file.Path;
 import java.util.List;
+import java.util.stream.Collectors;
 import java.util.concurrent.ExecutionException;
 
+import javax.swing.JCheckBox;
+import javax.swing.JDialog;
+import javax.swing.JOptionPane;
 import javax.swing.SwingUtilities;
 
 import net.imagej.Dataset;
@@ -49,9 +57,11 @@
 import org.junit.jupiter.api.Test;
 import org.scijava.Context;
 import org.scijava.command.CommandService;
+import org.scijava.ui.UIService;
 
 import ome.zarr.fijiui.open.OmeZarrOpenActions;
 import ome.zarr.fiji.Pyramidal;
+import ome.zarr.fiji.PyramidalBdv;
 import ome.zarr.fiji.plugins.PyramidalService;
 import ome.zarr.ZarrTestUtils;
 
@@ -76,6 +86,10 @@ private static void flushEventQueue() throws InterruptedException
 		}
 	}
 
+	private static final String SPOTS = "ome/zarr/testdata/bdv_testing/logo_spots.ome.zarr";
+
+	private static final String LABELS = "ome/zarr/testdata/bdv_testing/logo_labels.ome.zarr";
+
 	// 2 resolution levels: level 0 = 64x64x16, level 1 = 32x32x8
 	private static final String PYRAMID_RESOURCE = "ome/zarr/testdata/5d_testing/5d_dataset_v5.ome.zarr";
 
@@ -146,4 +160,70 @@ void runAfterBdvOpenCreatesSecondBdvDataset() throws URISyntaxException, Executi
 			assertSame( firstBdvPyramidal.getPyramidContents(), secondBdvPyramidal.getPyramidContents() );
 		}
 	}
+
+	/**
+	 * With two OME-Zarrs open in ImageJ, ticking both in the dialog shows them in one new BDV window.
+	 */
+	@Test
+	void runWithTwoOpenShowsTheTickedOnesInOneWindow() throws Exception
+	{
+		try (Context context = new Context())
+		{
+			new OmeZarrOpenActions( ZarrTestUtils.resourcePath( SPOTS ).toUri(), context ).showInImageJ();
+			new OmeZarrOpenActions( ZarrTestUtils.resourcePath( LABELS ).toUri(), context ).showInImageJ();
+			flushEventQueue();
+
+			AWTEventListener user = event -> {
+				if ( event.getID() != WindowEvent.WINDOW_OPENED || !( event.getSource() instanceof JDialog ) )
+					return;
+				JOptionPane pane = ( JOptionPane ) ( ( JDialog ) event.getSource() ).getContentPane().getComponent( 0 );
+				for ( Object checkbox : ( Object[] ) pane.getMessage() )
+					( ( JCheckBox ) checkbox ).setSelected( true ); // tick both
+				SwingUtilities.invokeLater( () -> pane.setValue( JOptionPane.OK_OPTION ) ); // press OK
+			};
+			Toolkit.getDefaultToolkit().addAWTEventListener( user, AWTEvent.WINDOW_EVENT_MASK );
+			try
+			{
+				context.getService( CommandService.class ).run( OpenInBDVCommand.class, true ).get();
+			}
+			finally
+			{
+				Toolkit.getDefaultToolkit().removeAWTEventListener( user );
+			}
+
+			List< PyramidalBdv< ? > > shown = bdvPyramidals( context );
+			assertEquals( 2, shown.size() );
+			assertSame( shown.get( 0 ).getBdvHandle(), shown.get( 1 ).getBdvHandle() );
+		}
+	}
+
+	/**
+	 * Headless, there is no dialog: with two OME-Zarrs open, only the active one is shown.
+	 */
+	@Test
+	void runHeadlessWithTwoOpenShowsOnlyTheActiveOne() throws Exception
+	{
+		try (Context context = new Context())
+		{
+			new OmeZarrOpenActions( ZarrTestUtils.resourcePath( SPOTS ).toUri(), context ).showInImageJ();
+			new OmeZarrOpenActions( ZarrTestUtils.resourcePath( LABELS ).toUri(), context ).showInImageJ();
+			flushEventQueue();
+			Pyramidal active = context.getService( PyramidalService.class ).getActivePyramidal();
+			context.getService( UIService.class ).setHeadless( true );
+
+			context.getService( CommandService.class ).run( OpenInBDVCommand.class, true ).get();
+
+			List< PyramidalBdv< ? > > shown = bdvPyramidals( context );
+			assertEquals( 1, shown.size() );
+			assertSame( active.getPyramidContents(), shown.get( 0 ).getPyramidContents() );
+		}
+	}
+
+	private static List< PyramidalBdv< ? > > bdvPyramidals( final Context context )
+	{
+		return context.getService( PyramidalService.class ).getPyramidals().stream()
+				.filter( PyramidalBdv.class::isInstance )
+				.map( pyramidal -> ( PyramidalBdv< ? > ) pyramidal )
+				.collect( Collectors.toList() );
+	}
 }