From 5e484069cabab7ef1ef7e1bae4b0ba1e1759bed4 Mon Sep 17 00:00:00 2001 From: Xu Han Date: Thu, 19 Oct 2017 01:18:08 -0400 Subject: [PATCH] add README for pstrip --- main_code/.gitignore | 1 + main_code/README.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 main_code/README.md diff --git a/main_code/.gitignore b/main_code/.gitignore index 09507ae..71db47e 100644 --- a/main_code/.gitignore +++ b/main_code/.gitignore @@ -4,3 +4,4 @@ !postprocessing.py !main.py !pstrip.py +!README.md diff --git a/main_code/README.md b/main_code/README.md new file mode 100644 index 0000000..d9ad9ff --- /dev/null +++ b/main_code/README.md @@ -0,0 +1,22 @@ +usage: +``` +python pstrip.py -i Input_Image [-m Mask_Name] [-o Output_Name] [-p platform] [-g gamma] [-l lambda] [-c correction] [-v] [-h] +``` +PCA model for Brain Extraction: +We provide arguments for user to specify, although the default settings are sufficient for most of the cases. + +required arguments: + -i , --input Input image name + +optional file arguments: + -m, --mask output mask name. If not specified, the mask is generated into input image folder. + -o, --output brain extracted image. If not specified, image is generated into input image folder. + +additional arguments: + -p, --platform platform (CPU/GPU), default GPU + -g, --gamma gamma for total variation term penalty, default 0.5 + -l, --lambda lambda for sparse term penalty, default 0.1 + -c, --correction number of correction (regularization) steps, default 0 + -d, --debug {0,1,2} Debug mode: [Tentative settings] all intermediate results will be saved in tmp_res folder. Be careful, this could occupy large space on disk if multiply images will be processed + -v, --version show program's version number and exit + -h, --help show this help message and exit