Create convertall_custom.py as a demonstration for a derived heuristic with custom_seqinfo

Author: yarikoptic

heudiconv/heuristics/convertall.py

@@ -3,7 +3,6 @@
 import logging
 from typing import Optional
 
-from heudiconv.dicoms import dw
 from heudiconv.utils import SeqInfo
 
 lgr = logging.getLogger("heudiconv")
@@ -19,21 +18,6 @@ def create_key(
     return (template, outtype, annotation_classes)
 
 
-def custom_seqinfo(wrapper: dw.Wrapper, series_files: list[str]) -> tuple[str, str]:
-    # Just a dummy demo for what custom_seqinfo could get/do
-    # for already loaded DICOM data, and including storing/returning
-    # the sample series file as was requested
-    # in https://github.com/nipy/heudiconv/pull/333
-    from nibabel.nicom.dicomwrappers import WrapperError
-
-    try:
-        affine = wrapper.affine.tobytes()
-    except WrapperError:
-        lgr.exception("Errored out while obtaining/converting affine")
-        affine = None
-    return affine, series_files[0]
-
-
 def infotodict(
     seqinfo: list[SeqInfo],
 ) -> dict[tuple[str, tuple[str, ...], None], list[str]]:

heudiconv/heuristics/convertall_custom.py

@@ -0,0 +1,25 @@
+"""A demo convertall heuristic with custom_seqinfo extracting affine and sample DICOM path
+
+This heuristic also demonstrates on how to create a "derived" heuristic which would augment
+behavior of an already existing heuristic without complete rewrite.  Such approach could be
+useful for heuristic like  reproin  to overload mapping etc.
+"""
+
+from .convertall import *  # noqa: F403
+
+
+def custom_seqinfo(series_files, wrapper, **kw):  # noqa: U100
+    """Demo for extracting custom header fields into custom_seqinfo field
+
+    Operates on already loaded DICOM data.
+    Origin: https://github.com/nipy/heudiconv/pull/333
+    """
+
+    from nibabel.nicom.dicomwrappers import WrapperError
+
+    try:
+        affine = wrapper.affine.tostring()
+    except WrapperError:
+        lgr.exception("Errored out while obtaining/converting affine")  # noqa: F405
+        affine = None
+    return affine, series_files[0]