Merge pull request #158 from bioio-devs/feature/dimension-properties

feature/dimension-properties

Author: BrianWhitneyAI

bioio/__init__.py

@@ -9,6 +9,7 @@
     from bioio_base.standard_metadata import StandardMetadata
     from bioio_base.types import (
         ArrayLike,
+        DimensionProperties,
         ImageLike,
         MetaArrayLike,
         PathLike,
@@ -22,6 +23,7 @@
     _fallback_symbols = [
         "ArrayLike",
         "DimensionNames",
+        "DimensionProperties",
         "Dimensions",
         "ImageLike",
         "MetaArrayLike",
@@ -50,6 +52,7 @@
     "ArrayLike",
     "BioImage",
     "DimensionNames",
+    "DimensionProperties",
     "Dimensions",
     "ImageLike",
     "MetaArrayLike",

bioio/bio_image.py

@@ -1010,6 +1010,17 @@ def scale(self) -> biob.types.Scale:
         """
         return self.reader.scale
 
+    @property
+    def dimension_properties(self) -> biob.types.DimensionProperties:
+        """
+        Returns
+        -------
+        dimension_properties: DimensionProperties
+            Per-dimension properties (value, type, unit) derived from the
+            underlying reader.
+        """
+        return self.reader.dimension_properties
+
     @property
     def time_interval(self) -> biob.types.TimeInterval:
         """

docs/api_reference.rst

@@ -24,6 +24,7 @@ Types and Aliases
    :recursive:
 
    ArrayLike
+   DimensionProperties
    MetaArrayLike
    Scale
    TimeInterval

pyproject.toml

@@ -31,7 +31,7 @@ dynamic = ["version"]
 dependencies = [
   # We always pin a specific version of bioio-base with
   # each release so that we avoid bioio + bioio-base misalignment.
-  "bioio-base==3.0.0",
+  "bioio-base~=3.1.0",
   "dask[array]>=2021.4.1",
   "numpy>=1.21.0",
   "ome-types[lxml]>=0.4.0",