Merge branch 'gps_wrapper' into 'master'

ENH: add wrapper for gps

See merge request fsl/fslpy!249

fsl/wrappers/__init__.py

@@ -107,4 +107,5 @@ from .melodic      import (melodic,         # noqa
 from .misc         import (fslreorient2std, # noqa
                            fslroi,
                            slicer,
-                           cluster)
+                           cluster,
+                           gps)

fsl/wrappers/misc.py

@@ -85,3 +85,22 @@ def cluster(input, thresh, **kwargs):
     cmd += wutils.applyArgStyle('--=', valmap=valmap, **kwargs)
 
     return cmd
+
+@wutils.fileOrArray('out', 'init')
+@wutils.fslwrapper
+def gps(out, ndir, **kwargs):
+    """Wrapper of the ``gps`` command
+
+    Usage example to get 128 gradient orientations on the whole sphere::
+
+        from fsl.wrappers import gps, LOAD
+        bvecs = gps(LOAD, 128, optws=True)['out']
+    """
+    valmap = {name: wutils.SHOW_IF_TRUE for name in [
+        'optws', 'report', 'verbose'
+    ]}
+
+    cmd = ['gps', f'--ndir={ndir}', f'--out={out}']
+    cmd += wutils.applyArgStyle('--=', valmap=valmap, **kwargs)
+
+    return cmd

tests/test_wrappers/test_wrappers.py

@@ -336,7 +336,6 @@ def test_fast():
         assert result.stdout[0] == ' '.join(expected)
 
 
-
 def test_fsl_anat():
     with asrt.disabled(), \
          run.dryrun(), \
@@ -349,3 +348,12 @@ def test_fsl_anat():
                     '-s', '25']
 
         assert result.stdout[0] == ' '.join(expected)
+
+
+def test_gps():
+    with asrt.disabled(), run.dryrun(), mockFSLDIR(bin=('gps',)) as fsldir:
+        gps = op.join(fsldir, 'bin', 'gps')
+        result = fw.gps('bvecs', 128, optws=True, ranseed=123)
+        expected = (gps + ' --ndir=128 --out=bvecs',
+                    ('--optws', '--ranseed=123'))
+        assert checkResult(result.stdout[0], *expected)