Update type information in read function

eigenvivek · Jun 26, 2024 · 1257a61 · 1257a61
1 parent 9bda058
commit 1257a61
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/diffdrr/data.py b/diffdrr/data.py
@@ -42,7 +42,7 @@ def read(
     volume: str | Path | ScalarImage,  # CT volume
     labelmap: str | Path | LabelMap = None,  # Labelmap for the CT volume
     labels: int | list = None,  # Labels from the mask of structures to render
-    orientation: str = "AP",  # Frame-of-reference change
+    orientation: str | None = "AP",  # Frame-of-reference change
     bone_attenuation_multiplier: float = 1.0,  # Scalar multiplier on density of high attenuation voxels
     fiducials: torch.Tensor = None,  # 3D fiducials in world coordinates
     **kwargs,  # Any additional information to be stored in the torchio.Subject

diff --git a/notebooks/api/03_data.ipynb b/notebooks/api/03_data.ipynb
@@ -113,7 +113,7 @@
     "    volume: str | Path | ScalarImage,  # CT volume\n",
     "    labelmap: str | Path | LabelMap = None,  # Labelmap for the CT volume\n",
     "    labels: int | list = None,  # Labels from the mask of structures to render\n",
-    "    orientation: str = \"AP\",  # Frame-of-reference change\n",
+    "    orientation: str | None = \"AP\",  # Frame-of-reference change\n",
     "    bone_attenuation_multiplier: float = 1.0,  # Scalar multiplier on density of high attenuation voxels\n",
     "    fiducials: torch.Tensor = None,  # 3D fiducials in world coordinates\n",
     "    **kwargs,  # Any additional information to be stored in the torchio.Subject\n",