sct_dmri_concat_b0_and_dwi.py: Clarified doc (#2650)

spinalcordtoolbox · Mar 31, 2020 · e5eee1f · e5eee1f
1 parent 266bfc8
commit e5eee1f
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/scripts/sct_dmri_concat_b0_and_dwi.py b/scripts/sct_dmri_concat_b0_and_dwi.py
@@ -24,7 +24,15 @@
 
 def get_parser():
     parser = argparse.ArgumentParser(
-        description="Concatenate b=0 scans with DWI time series and update the bvecs and bvals files.",
+        description="Concatenate b=0 scans with DWI time series and update the bvecs and bvals files.\n\n"
+                    "Example 1: Add two b=0 file at the beginning and one at the end of the DWI time series:\n"
+                    ">> sct_dmri_concat_b0_and_dwi -i b0-1.nii b0-2.nii dmri.nii b0-65.nii -bvec bvecs.txt -bval "
+                    "bvals.txt -order b0 b0 dwi b0 -o dmri_concat.nii -obval bvals_concat.txt -obvec "
+                    "bvecs_concat.txt\n\n"
+                    "Example 2: Concatenate two DWI series and add one b=0 file at the beginning:\n"
+                    ">> sct_dmri_concat_b0_and_dwi -i b0-1.nii dmri1.nii dmri2.nii -bvec bvecs1.txt bvecs2.txt -bval "
+                    "bvals1.txt bvals2.txt -order b0 dwi dwi -o dmri_concat.nii -obval bvals_concat.txt -obvec "
+                    "bvecs_concat.txt",
         formatter_class=SmartFormatter,
         add_help=None,
         prog=os.path.basename(__file__).strip(".py")