Skip to content
Snippets Groups Projects
Commit 6a6c00ed authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

DOC: Clarify fslstats wrapper usage

parent 2f160a70
No related branches found
No related tags found
No related merge requests found
...@@ -31,20 +31,28 @@ class fslstats: ...@@ -31,20 +31,28 @@ class fslstats:
present in older versions. present in older versions.
This ``fslstats`` command::
fslstats image -r -p 95 -R
is equivalent to this function call::
fslstats('image').r.p(95).R.run()
Any ``fslstats`` command-line option which does not require any arguments Any ``fslstats`` command-line option which does not require any arguments
(e.g. ``-r``) can be set by accessing an attribute on a ``fslstats`` (e.g. ``-r``) can be set by accessing an attribute on a ``fslstats``
object, e.g.:: object, e.g.::
stats = fslstats('image.nii.gz') fslstats('image.nii.gz').r.run()
stats.r
``fslstats`` command-line options which do require additional arguments ``fslstats`` command-line options which do require additional arguments
(e.g. ``-k``) can be set by calling a method on an ``fslstats`` object, (e.g. ``-k``) can be set by calling a method on an ``fslstats`` object,
e.g.:: e.g.::
stats = fslstats('image.nii.gz') stats = fslstats('image.nii.gz').k('mask.nii.gz').run()
stats.k('mask.nii.gz')
The ``fslstats`` command can be executed via the :meth:`run` method. The ``fslstats`` command can be executed via the :meth:`run` method.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment