Add nss param to ConfoundsCorrelationPlot.

Author: tsalo

niworkflows/interfaces/plotting.py

@@ -195,6 +195,12 @@ class _ConfoundsCorrelationPlotInputSpec(BaseInterfaceInputSpec):
         "correlation with `reference_column` will be "
         "selected.",
     )
+    ignore_initial_volumes = traits.Int(
+        0,
+        usedefault=True,
+        desc="Number of non-steady-state volumes at the beginning of the scan "
+        "to ignore.",
+    )
 
 
 class _ConfoundsCorrelationPlotOutputSpec(TraitedSpec):
@@ -223,6 +229,7 @@ def _run_interface(self, runtime):
             max_dim=self.inputs.max_dim,
             output_file=self._results["out_file"],
             reference=self.inputs.reference_column,
+            ignore_initial_volumes=self.inputs.ignore_initial_volumes,
         )
         return runtime
 

niworkflows/viz/plots.py

@@ -861,6 +861,7 @@ def confounds_correlation_plot(
     max_dim=20,
     output_file=None,
     reference="global_signal",
+    ignore_initial_volumes=0,
 ):
     """
     Generate a bar plot with the correlation of confounds.
@@ -889,6 +890,8 @@ def confounds_correlation_plot(
         of each confound regressor with a reference column. By default, this
         is the global signal (so that collinearities with the global signal
         can readily be assessed).
+    ignore_initial_volumes : :obj:`int`
+        Number of non-steady-state volumes at the beginning of the scan to ignore.
 
     Returns
     -------