update Readme and scripts

README.md

@@ -1,53 +1,69 @@
-Draw-EM Segmentation Software
-==========================================
+# Draw-EM Segmentation Software
+
+![segmentation image](segmentation.png)
 
 Draw-EM (Developing brain Region Annotation With Expectation-Maximization) is a package of [MIRTK](https://github.com/BioMedIA/MIRTK) developed by Antonios Makropoulos and the [BioMedIA](https://biomedia.doc.ic.ac.uk/) research group. 
-It provides a collection of command-line tools as well as pipelines for the segmentation of developing brain MR images.
+It provides a collection of command-line tools and pipelines for the segmentation of developing brain MR images.
+
+Draw-EM is used as part of the [dHCP structural pipeline](https://github.com/BioMedIA/dhcp-structural-pipeline) for the structural analysis (segmentation and surface extraction) of the neonatal brain.
+
 
+## Dependencies
+### FSL
 
-Installation
-------------
+The segmentation pipeline uses
+[FSL](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FSL). 
+See the [installation instructions](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation) for FSL.
+
+
+## Installation
 
 Draw-EM is part of MIRTK. 
-In order to compile it as part of MIRTK you need to do the following steps:
-- download (clone) Draw-EM inside the Packages folder of your MIRTK directory
-- enable compile of the package by setting the CMake flag "MODULE_DrawEM" of MIRTK to "ON" (using cmake or ccmake)
+In order to compile it as part of MIRTK you need to:
+- enable compilation of the package by setting the CMake flag "MODULE_DrawEM" of MIRTK to "ON" (using cmake or ccmake)
 - build MIRTK
 
 See the [installation instructions](https://mirtk.github.io/install.html) 
 for a step-by-step guide on how to install MIRTK.
 
-The segmentation pipeline further requires the following:
-- The atlases required by Draw-EM need to be downloaded from [here](https://www.doc.ic.ac.uk/~am411/atlases-DrawEM.html) and extracted inside the Draw-EM directory.
-- [FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/) installed
-- The N4BiasFieldCorrection from ANTS installed.
-
-Run
----
+## Running the pipeline
 
-The segmentation pipeline can be run with the following script:
+The segmentation pipeline can be run as follows:
 
-pipelines/neonatal-pipeline.sh 
+mirtk neonatal-segmentation <subject_T2> <age_at_scan>
 
-The script requires the T2 image and the age at scan of the subject to be segmented (as first and second argument respectively).
-Run the script without arguments for a detailed list of options.
+```
+Arguments:
+  <subject_T2>                  Nifti Image: The T2 image of the subject to be segmented.
+  <age_at_scan>                 Integer: Subject age in weeks. This is used to select the appropriate template for the initial registration. 
+			        					If the age is <28w or >44w, it will be set to 28w or 44w respectively.
+Options:
+  -d / -data-dir  <directory>   The directory used to run the script and output the files. 
+  -c / -cleanup  <0/1>          Whether cleanup of temporary files is required (default: 1)
+  -p / -save-posteriors  <0/1>  Whether the structures' posteriors are required (default: 0)
+  -t / -threads  <number>       Number of threads (CPU cores) allowed for the registration to run in parallel (default: 1)
+  -v / -verbose  <0/1>          Whether the script progress is reported (default: 1)
+  -h / -help / --help           Print usage.
+```
 
 
-License
--------
+## License
 
 Draw-EM is distributed under the terms of the Apache License Version 2.
 See the accompanying [license file](LICENSE.txt) for details. The license enables usage of
 Draw-EM in both commercial and non-commercial applications, without restrictions on the
 licensing applied to the combined work.
 
+## Releases 
+- v1.2: dHCP segmentation pipeline, method improvements described in [2]: multi-channel registration, modelling of hyper and hypo-intensities.
+- v1.1: initial code release, method described in [1].
 
 
-Citation and acknowledgements
------------------------------
+## Citation and acknowledgements
 
 In case you found Draw-EM useful please give appropriate credit to the software.
 
-Publication:
+Publications:
 
-A. Makropoulos et al. Automatic whole brain MRI segmentation of the developing neonatal brain, IEEE TMI, 2014
+1. A. Makropoulos et al. *"Automatic whole brain MRI segmentation of the developing neonatal brain"*, IEEE TMI, 2014
+2. A. Makropoulos, E. C. Robinson et al. *"The Developing Human Connectome Project: a Minimal Processing Pipeline for Neonatal Cortical Surface Reconstruction"*, NeuroImage, 2018

scripts/preprocess.sh

@@ -32,16 +32,6 @@ else
   export PATH="$FSLDIR/bin:$PATH"
 fi
 
-N4=N4
-if ! hash $N4 2>/dev/null; then
-  N4=N4BiasFieldCorrection
-  if ! hash $N4 2>/dev/null; then
-    echo "The N4 command is not installed!" 1>&2; 
-    exit 1; 
-  fi
-fi
-
-
 sdir=segmentations-data
 
 mkdir -p segmentations N4 dofs bias || exit 1
@@ -57,7 +47,7 @@ if [ ! -f N4/$subj.nii.gz ];then
   fi
 
   #bias correct
-  run $N4 3 -i N4/${subj}_rescaled.nii.gz -x segmentations/${subj}_brain_mask.nii.gz -o "[N4/${subj}_corr.nii.gz,bias/$subj.nii.gz]" -c "[50x50x50,0.001]" -s 2 -b "[100,3]" -t "[0.15,0.01,200]"
+  run mirtk N4 3 -i N4/${subj}_rescaled.nii.gz -x segmentations/${subj}_brain_mask.nii.gz -o "[N4/${subj}_corr.nii.gz,bias/$subj.nii.gz]" -c "[50x50x50,0.001]" -s 2 -b "[100,3]" -t "[0.15,0.01,200]"
   run mirtk calculate N4/${subj}_corr.nii.gz -mul segmentations/${subj}_brain_mask.nii.gz -out N4/${subj}_corr.nii.gz 
 
   #rescale image