test: Add test for FD interface

Author: effigies

fmriprep/interfaces/tests/data/sub-01_task-mixedgamblestask_run-01_desc-motion_timeseries.tsv

@@ -1,17 +1,17 @@
-trans_x	trans_y	trans_z	rot_x	rot_y	rot_z
-1.19425e-05	0.0443863	0.00472985	0.000356176	-0.000617445	0.0
--2.57666e-05	0.0463662	0.0623273	-0.000208795	-0.00012937	0.0
--2.64055e-05	-0.00438628	0.067513	-2.59508e-05	-0.00012937	0.000173904
-0.0161645	-0.0226134	0.0630764	-2.59508e-05	-0.000199844	0.000279081
-0.0161497	-0.0263834	0.0464668	0.000161259	-0.00012937	0.000573335
-0.0161482	-0.0226144	0.0345415	6.52323e-05	-7.276439999999998e-05	0.000573335
-0.0121946	-0.00426109	0.0671039	-2.59508e-05	-0.00012937	0.000312581
-0.0121556	-0.0175135	0.04042	-2.59508e-05	-0.00012937	0.000166363
-0.0126526	-0.000813328	0.0778061	-2.59508e-05	-0.00012937	0.000166363
-0.012614	0.0250656	0.106248	-0.000320333	0.000149271	0.000166363
-0.0126599	-0.0252459	0.0731423999999999	2.99512e-05	-0.000204037	0.000166363
--0.00608005	0.0349207	0.110289	-0.000485119	-0.00012937	8.57718e-05
--0.00607796	-0.00933714	0.0796319999999999	-0.000126125	-0.00012937	0.000166363
-0.0124531	0.00996903	0.0986678	-0.000266813	-0.000207949	0.000166363
-0.010915	-0.00933714	0.0986667	-0.000126125	-0.000248281	0.000166363
-0.0119349	0.00531637	0.0808524	-0.000209587	-0.0	0.000226933
+trans_x	trans_y	trans_z	rot_x	rot_y	rot_z	framewise_displacement
+1.19425e-05	0.0443863	0.00472985	0.000356176	-0.000617445	0.0	n/a
+-2.57666e-05	0.0463662	0.0623273	-0.000208795	-0.00012937	0.0	0.1122673591
+-2.64055e-05	-0.00438628	0.067513	-2.59508e-05	-0.00012937	0.000173904	0.0737762289
+0.0161645	-0.0226134	0.0630764	-2.59508e-05	-0.000199844	0.000279081	0.0476371754999999
+0.0161497	-0.0263834	0.0464668	0.000161259	-0.00012937	0.000573335	0.04799129
+0.0161482	-0.0226144	0.0345415	6.52323e-05	-7.276439999999998e-05	0.000573335	0.023327415
+0.0121946	-0.00426109	0.0671039	-2.59508e-05	-0.00012937	0.000312581	0.075296445
+0.0121556	-0.0175135	0.04042	-2.59508e-05	-0.00012937	0.000166363	0.04728621
+0.0126526	-0.000813328	0.0778061	-2.59508e-05	-0.00012937	0.000166363	0.054583272
+0.012614	0.0250656	0.106248	-0.000320333	0.000149271	0.000166363	0.0830105879999999
+0.0126599	-0.0252459	0.0731423999999999	2.99512e-05	-0.000204037	0.000166363	0.11864261
+-0.00608005	0.0349207	0.110289	-0.000485119	-0.00012937	8.57718e-05	0.1495695699999999
+-0.00607796	-0.00933714	0.0796319999999999	-0.000126125	-0.00012937	0.000166363	0.09689619
+0.0124531	0.00996903	0.0986678	-0.000266813	-0.000207949	0.000166363	0.06783638
+0.010915	-0.00933714	0.0986667	-0.000126125	-0.000248281	0.000166363	0.02989637
+0.0119349	0.00531637	0.0808524	-0.000209587	-0.0	0.000226933	0.0531033599999999

fmriprep/interfaces/tests/test_confounds.py

@@ -64,3 +64,19 @@ def test_FSLMotionParams(tmp_path, data_dir):
     )
     max_diff = (orig_params - derived_params).abs().max()
     assert np.all(max_diff < limits)
+
+
+def test_FramewiseDisplacement(tmp_path, data_dir):
+    timeseries = data_dir / 'sub-01_task-mixedgamblestask_run-01_desc-motion_timeseries.tsv'
+
+    framewise_displacement = pe.Node(
+        confounds.FramewiseDisplacement(in_file=str(timeseries)),
+        name='framewise_displacement',
+        base_dir=str(tmp_path),
+    )
+    res = framewise_displacement.run()
+
+    orig = pd.read_csv(timeseries, sep='\t')['framewise_displacement']
+    derived = pd.read_csv(res.outputs.out_file, sep='\t')['FramewiseDisplacement']
+
+    assert np.allclose(orig.values, derived.values, equal_nan=True)