✨ Introduce mri_robust_template as option for longitudinal template generation

CHANGELOG.md

@@ -24,13 +24,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Required positional parameter "wf" in input and output of `ingress_pipeconfig_paths` function, where a node to reorient templates is added to the `wf`.
 - Required positional parameter "orientation" to `resolve_resolution`.
 - Optional positional argument "cfg" to `create_lesion_preproc`.
+- `mri_robust_template` for longitudinal template generation.
+- `max_iter` parameter for longitudinal template generation.
 
 ### Changed
 
 - Moved `pygraphviz` from requirements to `graphviz` optional dependencies group.
 - Automatically tag untagged `subject_id` and `unique_id` as `!!str` when loading data config files.
 - Made orientation configurable (was hard-coded as "RPI").
 - Disabled variant image builds.
+- Made `mri_robust_template` default implementation for longitudinal template generation.
 
 ### Fixed
 

CPAC/alff/alff.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2012-2024  C-PAC Developers
+# Copyright (C) 2012-2025  C-PAC Developers
 
 # This file is part of C-PAC.
 
@@ -23,9 +23,8 @@
 from CPAC.alff.utils import get_opt_string
 from CPAC.pipeline import nipype_pipeline_engine as pe
 from CPAC.pipeline.nodeblock import nodeblock
-from CPAC.registration.registration import apply_transform
+from CPAC.registration.utils import apply_transform
 from CPAC.utils.interfaces import Function
-from CPAC.utils.utils import check_prov_for_regtool
 
 
 def create_alff(wf_name="alff_workflow"):
@@ -320,10 +319,7 @@ def alff_falff(wf, cfg, strat_pool, pipe_num, opt=None):
 def alff_falff_space_template(wf, cfg, strat_pool, pipe_num, opt=None):
     outputs = {}
     if strat_pool.check_rpool("desc-denoisedNofilt_bold"):
-        xfm_prov = strat_pool.get_cpac_provenance(
-            "from-bold_to-template_mode-image_xfm"
-        )
-        reg_tool = check_prov_for_regtool(xfm_prov)
+        reg_tool = strat_pool.reg_tool("from-bold_to-template_mode-image_xfm")
 
         num_cpus = cfg.pipeline_setup["system_config"]["max_cores_per_participant"]
 

CPAC/anat_preproc/anat_preproc.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2012-2023  C-PAC Developers
+# Copyright (C) 2012-2025  C-PAC Developers
 
 # This file is part of C-PAC.
 
@@ -34,7 +34,7 @@
     wb_command,
 )
 from CPAC.pipeline import nipype_pipeline_engine as pe
-from CPAC.pipeline.nodeblock import nodeblock
+from CPAC.pipeline.nodeblock import nodeblock, NODEBLOCK_RETURN
 from CPAC.utils.interfaces import Function
 from CPAC.utils.interfaces.fsl import Merge as fslMerge
 
@@ -1227,15 +1227,7 @@ def freesurfer_fsl_brain_connector(wf, cfg, strat_pool, pipe_num, opt):
     wf.connect(node, out, convert_fs_T1_to_nifti, "in_file")
 
     # 3dresample -orient RPI -inset brainmask.nii.gz -prefix brain_fs.nii.gz
-    reorient_fs_brainmask = pe.Node(
-        interface=afni.Resample(),
-        name=f"reorient_fs_brainmask_{node_id}",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
-    )
-    reorient_fs_brainmask.inputs.orientation = cfg.pipeline_setup["desired_orientation"]
-    reorient_fs_brainmask.inputs.outputtype = "NIFTI_GZ"
-
+    reorient_fs_brainmask = cfg.orientation_node(f"reorient_fs_brainmask_{node_id}")
     wf.connect(
         convert_fs_brainmask_to_nifti, "out_file", reorient_fs_brainmask, "in_file"
     )
@@ -1249,15 +1241,7 @@ def freesurfer_fsl_brain_connector(wf, cfg, strat_pool, pipe_num, opt):
     wf.connect(reorient_fs_brainmask, "out_file", binarize_fs_brain, "in_file")
 
     # 3dresample -orient RPI -inset T1.nii.gz -prefix head_fs.nii.gz
-    reorient_fs_T1 = pe.Node(
-        interface=afni.Resample(),
-        name=f"reorient_fs_T1_{node_id}",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
-    )
-    reorient_fs_T1.inputs.orientation = cfg.pipeline_setup["desired_orientation"]
-    reorient_fs_T1.inputs.outputtype = "NIFTI_GZ"
-
+    reorient_fs_T1 = cfg.orientation_node(f"reorient_fs_T1_{node_id}")
     wf.connect(convert_fs_T1_to_nifti, "out_file", reorient_fs_T1, "in_file")
 
     # flirt -in head_fs.nii.gz -ref ${FSLDIR}/data/standard/MNI152_T1_1mm.nii.gz \
@@ -1447,22 +1431,14 @@ def mask_T2(wf_name="mask_T2"):
     inputs=["T1w"],
     outputs=["desc-preproc_T1w", "desc-reorient_T1w", "desc-head_T1w"],
 )
-def anatomical_init(wf, cfg, strat_pool, pipe_num, opt=None):
+def anatomical_init(wf, cfg, strat_pool, pipe_num, opt=None) -> NODEBLOCK_RETURN:
     anat_deoblique = pe.Node(interface=afni.Refit(), name=f"anat_deoblique_{pipe_num}")
     anat_deoblique.inputs.deoblique = True
 
     node, out = strat_pool.get_data("T1w")
     wf.connect(node, out, anat_deoblique, "in_file")
 
-    anat_reorient = pe.Node(
-        interface=afni.Resample(),
-        name=f"anat_reorient_{pipe_num}",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
-    )
-    anat_reorient.inputs.orientation = cfg.pipeline_setup["desired_orientation"]
-    anat_reorient.inputs.outputtype = "NIFTI_GZ"
-
+    anat_reorient = cfg.orientation_node(f"anat_reorient_{pipe_num}")
     wf.connect(anat_deoblique, "out_file", anat_reorient, "in_file")
 
     outputs = {
@@ -2262,15 +2238,7 @@ def anatomical_init_T2(wf, cfg, strat_pool, pipe_num, opt=None):
     node, out = strat_pool.get_data("T2w")
     wf.connect(node, out, T2_deoblique, "in_file")
 
-    T2_reorient = pe.Node(
-        interface=afni.Resample(),
-        name=f"T2_reorient_{pipe_num}",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
-    )
-    T2_reorient.inputs.orientation = cfg.pipeline_setup["desired_orientation"]
-    T2_reorient.inputs.outputtype = "NIFTI_GZ"
-
+    T2_reorient = cfg.orientation_node(f"T2_reorient_{pipe_num}")
     wf.connect(T2_deoblique, "out_file", T2_reorient, "in_file")
 
     outputs = {

CPAC/anat_preproc/lesion_preproc.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2019-2023  C-PAC Developers
+# Copyright (C) 2019-2025  C-PAC Developers
 
 # This file is part of C-PAC.
 
@@ -20,6 +20,7 @@
 
 from CPAC.pipeline import nipype_pipeline_engine as pe
 from CPAC.utils.interfaces import Function
+from CPAC.utils.nifti_utils import orientation_node
 
 
 def inverse_lesion(lesion_path):
@@ -126,18 +127,10 @@ def create_lesion_preproc(cfg=None, wf_name="lesion_preproc"):
     preproc.connect(lesion_deoblique, "out_file", outputnode, "refit")
 
     # Anatomical reorientation
-    lesion_reorient = pe.Node(
-        interface=afni.Resample(),
-        name="lesion_reorient",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
+    node_name = "lesion_reorient"
+    lesion_reorient = (
+        cfg.orientation_node(node_name) if cfg else orientation_node(node_name, "RPI")
     )
-
-    lesion_reorient.inputs.orientation = (
-        cfg.pipeline_setup["desired_orientation"] if cfg else "RPI"
-    )
-    lesion_reorient.inputs.outputtype = "NIFTI_GZ"
-
     preproc.connect(lesion_deoblique, "out_file", lesion_reorient, "in_file")
     preproc.connect(lesion_reorient, "out_file", outputnode, "reorient")
 

CPAC/func_preproc/func_motion.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2024  C-PAC Developers
+# Copyright (C) 2012-2025  C-PAC Developers
 
 # This file is part of C-PAC.
 
@@ -34,7 +34,6 @@
 from CPAC.pipeline.nodeblock import nodeblock
 from CPAC.pipeline.schema import valid_options
 from CPAC.utils.interfaces.function import Function
-from CPAC.utils.utils import check_prov_for_motion_tool
 
 
 @nodeblock(
@@ -68,8 +67,7 @@
 )
 def calc_motion_stats(wf, cfg, strat_pool, pipe_num, opt=None):
     """Calculate motion statistics for motion parameters."""
-    motion_prov = strat_pool.get_cpac_provenance("desc-movementParameters_motion")
-    motion_correct_tool = check_prov_for_motion_tool(motion_prov)
+    motion_correct_tool = strat_pool.motion_tool("desc-movementParameters_motion")
     coordinate_transformation = [
         "filtered-coordinate-transformation",
         "coordinate-transformation",

CPAC/func_preproc/func_preproc.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2023  C-PAC Developers
+# Copyright (C) 2012-2025  C-PAC Developers
 
 # This file is part of C-PAC.
 
@@ -521,16 +521,7 @@ def func_reorient(wf, cfg, strat_pool, pipe_num, opt=None):
     node, out = strat_pool.get_data("bold")
     wf.connect(node, out, func_deoblique, "in_file")
 
-    func_reorient = pe.Node(
-        interface=afni_utils.Resample(),
-        name=f"func_reorient_{pipe_num}",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
-    )
-
-    func_reorient.inputs.orientation = cfg.pipeline_setup["desired_orientation"]
-    func_reorient.inputs.outputtype = "NIFTI_GZ"
-
+    func_reorient = cfg.orientation_node(f"func_reorient_{pipe_num}")
     wf.connect(func_deoblique, "out_file", func_reorient, "in_file")
 
     outputs = {
@@ -1283,16 +1274,7 @@ def bold_mask_anatomical_refined(wf, cfg, strat_pool, pipe_num, opt=None):
     node, out = strat_pool.get_data("bold")
     wf.connect(node, out, func_deoblique, "in_file")
 
-    func_reorient = pe.Node(
-        interface=afni_utils.Resample(),
-        name=f"raw_func_reorient_{pipe_num}",
-        mem_gb=0,
-        mem_x=(0.0115, "in_file", "t"),
-    )
-
-    func_reorient.inputs.orientation = cfg.pipeline_setup["desired_orientation"]
-    func_reorient.inputs.outputtype = "NIFTI_GZ"
-
+    func_reorient = cfg.orientation_node(f"raw_func_reorient_{pipe_num}")
     wf.connect(func_deoblique, "out_file", func_reorient, "in_file")
 
     wf.connect(func_reorient, "out_file", init_bold_mask, "inputspec.func")

CPAC/longitudinal/__init__.py

@@ -18,6 +18,7 @@
 
 from CPAC.utils.docs import DOCS_URL_PREFIX
 
+assert isinstance(__doc__, str)
 __doc__ += f"""
 
 See {DOCS_URL_PREFIX}/user/longitudinal