test: Add doctest to ApplyCoeffsField

Author: effigies

sdcflows/conftest.py

@@ -72,6 +72,7 @@ def doctest_fixture(doctest_namespace, request):
             dsA_dir=data_dir / "dsA",
             dsB_dir=data_dir / "dsB",
             dsC_dir=data_dir / "dsC",
+            data_dir = data_dir,
         )
         doctest_namespace.update((key, Path(val.root)) for key, val in layouts.items())
 

sdcflows/interfaces/bspline.py

@@ -380,6 +380,24 @@ class ApplyCoeffsField(SimpleInterface):
        With those coordinates known, interpolation is trivial.
     4. Generate a spatial image with the new data.
 
+    Example
+    -------
+
+    >>> from sdcflows.interfaces.bspline import ApplyCoeffsField
+    >>> unwarp = ApplyCoeffsField(pe_dir='j', ro_time=0.03125)
+    >>> unwarp.inputs.in_data = str(data_dir / 'epi.nii.gz')
+    >>> unwarp.inputs.in_coeff = str(data_dir / 'topup-coeff.nii.gz')
+    >>> unwarp.inputs.data2fmap_xfm = str(data_dir / 'epi2fmap_xfm.txt')
+    >>> result = unwarp.run()  # doctest: +SKIP
+
+    Inverse transforms may be used instead:
+
+    >>> unwarp = ApplyCoeffsField(pe_dir='j', ro_time=0.03125)
+    >>> unwarp.inputs.in_data = str(data_dir / 'epi.nii.gz')
+    >>> unwarp.inputs.in_coeff = str(data_dir / 'topup-coeff.nii.gz')
+    >>> unwarp.inputs.fmap2data_xfm = str(data_dir / 'fmap2epi_xfm.txt')
+    >>> result = unwarp.run()  # doctest: +SKIP
+
     """
 
     input_spec = _ApplyCoeffsFieldInputSpec