WIP: Volumetric Segmentations

docs/package.rst

@@ -75,6 +75,15 @@ highdicom.utils module
    :undoc-members:
    :show-inheritance:
 
+highdicom.volume module
++++++++++++++++++++++++
+
+.. automodule:: highdicom.volume
+   :members:
+   :inherited-members: pydicom.dataset.Dataset,pydicom.sequence.Sequence,Dataset,Sequence,list,str,DataElementSequence,enum.Enum,Enum,
+   :special-members: __call__
+   :undoc-members:
+   :show-inheritance:
 
 .. _highdicom-legacy-subpackage:
 

docs/seg.rst

@@ -447,7 +447,7 @@ segments. Note that passing a "label map" is purely a convenience provided by
 (`highdicom` splits the label map into multiple single-segment frames and
 stores these, as required by the standard).
 
-Therefore, The following snippet produces an equivalent SEG image to the
+Therefore, the following snippet produces an equivalent SEG image to the
 previous snippet, but passes the mask as a label map rather than as a stack of
 segments.
 

pyproject.toml

@@ -35,6 +35,7 @@ dependencies = [
     "pillow>=8.3",
     "pydicom>=3.0.1",
     "pyjpegls>=1.0.0",
+    "typing-extensions>=4.0.0",
 ]
 
 [project.optional-dependencies]

src/highdicom/__init__.py

@@ -34,11 +34,13 @@
     VOILUTTransformation,
 )
 from highdicom.enum import (
+    AxisHandedness,
     AnatomicalOrientationTypeValues,
     CoordinateSystemNames,
     ContentQualificationValues,
     DimensionOrganizationTypeValues,
     LateralityValues,
+    PadModes,
     PatientSexValues,
     PhotometricInterpretationValues,
     PixelRepresentationValues,
@@ -56,13 +58,16 @@
 from highdicom.uid import UID
 from highdicom import utils
 from highdicom.version import __version__
+from highdicom import volume
+
 
 __all__ = [
     'LUT',
     'UID',
     'VOILUT',
     'AlgorithmIdentificationSequence',
     'AnatomicalOrientationTypeValues',
+    'AxisHandedness',
     'ContentCreatorIdentificationCodeSequence',
     'ContentQualificationValues',
     'CoordinateSystemNames',
@@ -71,6 +76,7 @@
     'LateralityValues',
     'ModalityLUT',
     'ModalityLUTTransformation',
+    'PadModes',
     'PaletteColorLUT',
     'PaletteColorLUTTransformation',
     'PatientOrientationValuesBiped',
@@ -112,4 +118,5 @@
     'spatial',
     'sr',
     'utils',
+    'volume',
 ]

src/highdicom/_module_utils.py

@@ -285,6 +285,7 @@ def does_iod_have_pixel_data(sop_class_uid: str) -> bool:
 
 def is_multiframe_image(dataset: Dataset):
     """Determine whether an image is a multiframe image.
+
     The definition used is whether the IOD allows for multiple frames, not
     whether this particular instance has more than one frame.