Add export option for single-scale OME-Zarr

volumina/widgets/hdf5ExportFileOptionsWidget.py → volumina/widgets/hierarchicalFileExportOptionsWidget.py

@@ -1,7 +1,7 @@
 ###############################################################################
 #   volumina: volume slicing and editing library
 #
-#       Copyright (C) 2011-2018, the ilastik developers
+#       Copyright (C) 2011-2024, the ilastik developers
 #                                <[email protected]>
 #
 # This program is free software; you can redistribute it and/or
@@ -20,18 +20,22 @@
 # 		   http://ilastik.org/license/
 ###############################################################################
 import os
+from typing import Tuple
 
 from PyQt5 import uic
 from PyQt5.QtCore import pyqtSignal, Qt, QEvent
 from PyQt5.QtWidgets import QWidget, QFileDialog
 
 
-class Hdf5ExportFileOptionsWidget(QWidget):
+class HierarchicalFileExportOptionsWidget(QWidget):
     pathValidityChange = pyqtSignal(bool)
 
-    def __init__(self, parent):
-        super(Hdf5ExportFileOptionsWidget, self).__init__(parent)
+    def __init__(self, parent, file_extensions: Tuple[str, ...], default_extension: str, extension_description: str):
+        super().__init__(parent)
         uic.loadUi(os.path.splitext(__file__)[0] + ".ui", self)
+        self.file_extensions = file_extensions
+        self.default_extension = default_extension
+        self.extension_description = extension_description
 
         self.settings_are_valid = True
 
@@ -51,7 +55,7 @@
         self.datasetEdit.installEventFilter(self)
 
     def showEvent(self, event):
-        super(Hdf5ExportFileOptionsWidget, self).showEvent(event)
+        super().showEvent(event)
         self.updateFromSlots()
 
     def eventFilter(self, watched, event):
@@ -70,7 +74,7 @@
         was_valid = self.settings_are_valid
         datasetName = self.datasetEdit.text()
         self._datasetNameSlot.setValue(str(datasetName))
-        self.settings_are_valid = str(datasetName) != ""
+        self.settings_are_valid = str(datasetName) != "" or self.default_extension == "zarr"
         if self.settings_are_valid != was_valid:
             self.pathValidityChange.emit(self.settings_are_valid)
 
@@ -95,8 +99,8 @@
         if self._filepathSlot.ready():
             file_path = self._filepathSlot.value
             file_path, ext = os.path.splitext(file_path)
-            if ext != ".h5" and ext != ".hdf5":
-                file_path += ".h5"
+            if ext not in self.file_extensions:
+                file_path += f".{self.default_extension}"
             else:
                 file_path += ext
             self.filepathEdit.setText(file_path)
@@ -115,9 +119,9 @@
         else:
             starting_dir = os.path.expanduser("~")
 
-        dlg = QFileDialog(self, "Export Location", starting_dir, "HDF5 Files (*.h5 *.hdf5)")
+        dlg = QFileDialog(self, "Export Location", starting_dir, self.extension_description)
 
-        dlg.setDefaultSuffix("h5")
+        dlg.setDefaultSuffix(self.default_extension)
         dlg.setAcceptMode(QFileDialog.AcceptSave)
         if not dlg.exec_():
             return
@@ -148,7 +152,7 @@
     op = OpMock(graph=Graph())
 
     app = QApplication([])
-    w = Hdf5ExportFileOptionsWidget(None)
+    w = HierarchicalFileExportOptionsWidget(None, (".h5"), "h5", "H5 Files (*.h5)")
     w.initSlots(op.Filepath, op.DatasetName, op.FullPath)
     w.show()
     app.exec_()

volumina/widgets/multiformatSlotExportFileOptionsWidget.py

@@ -31,8 +31,7 @@
 from PyQt5.QtWidgets import QWidget
 
 from .singleFileExportOptionsWidget import SingleFileExportOptionsWidget
-from .hdf5ExportFileOptionsWidget import Hdf5ExportFileOptionsWidget
-from .n5ExportFileOptionsWidget import N5ExportFileOptionsWidget
+from .hierarchicalFileExportOptionsWidget import HierarchicalFileExportOptionsWidget
 from .stackExportFileOptionsWidget import StackExportFileOptionsWidget
 
 try:
@@ -73,7 +72,9 @@
 
         # HDF5
         for fmt in ("compressed hdf5", "hdf5"):
-            hdf5OptionsWidget = Hdf5ExportFileOptionsWidget(self)
+            hdf5OptionsWidget = HierarchicalFileExportOptionsWidget(
+                self, (".h5", ".hdf5"), "h5", "HDF5 files (*.h5 *.hdf5)"
+            )
             hdf5OptionsWidget.initSlots(
                 opDataExport.OutputFilenameFormat, opDataExport.OutputInternalPath, opDataExport.ExportPath
             )
@@ -82,13 +83,21 @@
 
         # N5
         for fmt in ("compressed n5", "n5"):
-            n5OptionsWidget = N5ExportFileOptionsWidget(self)
+            n5OptionsWidget = HierarchicalFileExportOptionsWidget(self, (".n5",), "n5", "N5 files (*.n5)")
             n5OptionsWidget.initSlots(
                 opDataExport.OutputFilenameFormat, opDataExport.OutputInternalPath, opDataExport.ExportPath
             )
             n5OptionsWidget.pathValidityChange.connect(self._handlePathValidityChange)
             self._format_option_editors[fmt] = n5OptionsWidget
 
+        # Zarr
+        zarrOptionsWidget = HierarchicalFileExportOptionsWidget(self, (".zarr",), "zarr", "Zarr files (*.zarr)")
+        zarrOptionsWidget.initSlots(
+            opDataExport.OutputFilenameFormat, opDataExport.OutputInternalPath, opDataExport.ExportPath
+        )
+        zarrOptionsWidget.pathValidityChange.connect(self._handlePathValidityChange)
+        self._format_option_editors["single-scale OME-Zarr"] = zarrOptionsWidget
+
         # Numpy
         npyOptionsWidget = SingleFileExportOptionsWidget(self, "npy", "numpy files (*.npy)")
         npyOptionsWidget.initSlots(opDataExport.OutputFilenameFormat, opDataExport.ExportPath)