tk-rt-viewer 2.2.0__tar.gz → 2.2.1__tar.gz

{tk_rt_viewer-2.2.0 → tk_rt_viewer-2.2.1}/CHANGELOG.md

@@ -30,6 +30,10 @@ Loading a series picked from a scan now reads only that series' files.
   directory holding a listed series also holds another image series.
   Non-image objects and the phases of one 4DCT may share a directory. Off by
   default; `MultiplePatientError` is still checked first.
+- **`NON_IMAGE_MODALITIES`** (formerly the private `_NON_IMAGE_MODALITIES`):
+  the modalities never treated as an image series, so a host that sorts
+  files into per-series folders agrees with the scan on what an image
+  series is.
 
 ### Changed
 

{tk_rt_viewer-2.2.0 → tk_rt_viewer-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tk-rt-viewer
-Version: 2.2.0
+Version: 2.2.1
 Summary: SimpleITK-based DICOM-RT MPR viewer widget for Tkinter (CT, RT-DOSE, RT-STRUCT, DVH)
 Project-URL: Homepage, https://github.com/oki1002/DICOM_RT_Viewer
 Project-URL: Repository, https://github.com/oki1002/DICOM_RT_Viewer

{tk_rt_viewer-2.2.0 → tk_rt_viewer-2.2.1}/src/tk_rt_viewer/__init__.py

@@ -40,7 +40,7 @@ Submodule API (import from the submodule)
     validate_dicom_files, find_reg_matrices, scan_dicom_series,
     load_scanned_series, load_phase_series, select_phase_series,
     load_all_series, load_dcm_series, normalize_phase_label,
-    MultiplePatientError, MixedSeriesDirectoryError
+    MultiplePatientError, MixedSeriesDirectoryError, NON_IMAGE_MODALITIES
 
 ``tk_rt_viewer.rtstruct_io``
     load_rt_struct, mask2rtstruct, save_structure_set,
@@ -104,7 +104,7 @@ __all__ = [
     "StructureSet",
     "to_gy_pairs",
 ]
-__version__ = "2.2.0"
+__version__ = "2.2.1"
 
 
 def __getattr__(name: str) -> Any:

{tk_rt_viewer-2.2.0 → tk_rt_viewer-2.2.1}/src/tk_rt_viewer/io.py

@@ -20,6 +20,9 @@ load_phase_series(phases, reg_files=(), max_workers=None)
     -> dict[str, SeriesInfo]
     Load the phases of a scanned 4DCT, reading only their own files.
 
+NON_IMAGE_MODALITIES
+    Modalities never treated as an image series (RT objects, REG, SR, ...).
+
 select_phase_series(all_series, phases) -> dict[str, SeriesInfo]
     Pick the 4DCT phases named by a scan result out of a load_all_series map.
 
@@ -70,8 +73,9 @@ _PHASE_LABEL_PATTERN = re.compile(r"\d+%")
 #: Modalities never loaded as a displayable image series. Without this,
 #: GDCM enumerates RT objects alongside the images and they are read through
 #: the CT path (RT-DOSE without its DoseGridScaling). RT-DOSE has its own
-#: loader, :func:`load_rt_dose`.
-_NON_IMAGE_MODALITIES: frozenset[str] = frozenset(
+#: loader, :func:`load_rt_dose`. Public so hosts that reorganise files agree
+#: with :func:`scan_dicom_series` on what counts as an image series.
+NON_IMAGE_MODALITIES: frozenset[str] = frozenset(
     {"RTSTRUCT", "RTPLAN", "RTRECORD", "RTDOSE", "REG", "SR", "PR", "KO", "SEG"}
 )
 
@@ -492,7 +496,7 @@ def scan_dicom_series(
         series_uid = str(ds.get("SeriesInstanceUID", ""))
         if not series_uid:
             continue
-        if modality not in _NON_IMAGE_MODALITIES:
+        if modality not in NON_IMAGE_MODALITIES:
             image_series_by_dir.setdefault(file.parent, set()).add(series_uid)
         if modality not in modalities:
             continue
@@ -937,7 +941,7 @@ def _load_all_series_impl(
     for dcm_dir in sorted(scan.dirs_with_dicom):
         for sid in reader.GetGDCMSeriesIDs(str(dcm_dir)):
             modality = scan.modality_by_series.get(sid, "")
-            if modality.upper() in _NON_IMAGE_MODALITIES:
+            if modality.upper() in NON_IMAGE_MODALITIES:
                 logger.info(f"Skipping {modality} series '{sid}' (not an image).")
                 continue
             raw_image, file_names = _read_series(reader, dcm_dir, sid)