22
33# DSST Defacing Pipeline
44
5- <<<<<<< HEAD
6- The DSST Defacing Pipeline has been developed to make the process of defacing anatomical scans of large datasets,
7- visually inspecting for accuracy and fixing scans that fail visual inspection more efficient and straightforward. The
8- pipeline _ requires_ the input dataset to be in BIDS format. A conceptual description of the pipeline can
9- found [ here] ( #conceptual-design ) .
10- =======
115The DSST Defacing Pipeline has been developed to make the process of defacing anatomical scans of large datasets,
126visually inspecting for accuracy and fixing scans that fail visual inspection more efficient and straightforward. The
137pipeline _ requires_ the input dataset to be in BIDS format. A conceptual description of the pipeline can
148found [ here] ( #conceptual-design ) .
159
1610This pipeline is designed and tested to work on the NIH HPC systems. While it's possible to get the pipeline running on
1711other platforms, please note that it can be error-prone and is not recommended.
18- > > > > > > > 8dc705ab68bf38be986c6f33b50d80af46af7beb
1912
2013## Usage Instructions
2114
@@ -25,9 +18,6 @@ other platforms, please note that it can be error-prone and is not recommended.
2518git clone
[email protected] :nih-fmrif/dsst-defacing-pipeline.git
2619```
2720
28- <<<<<<< HEAD
29- =======
30-
3121### Install required packages
3222
3323Apart from AFNI and FSL packages, available as HPC modules, users will need the following packages in their working
@@ -52,8 +42,6 @@ Once conda finishes creating the virtual environment, activate `dsstdeface`.
5242 conda activate dsstdeface
5343 ```
5444
55- > > > > > > > 8dc705ab68bf38be986c6f33b50d80af46af7beb
56-
5745### Run ` dsst_defacing_wf.py `
5846
5947To deface anatomical scans in the dataset, run ` dsst_defacing_wf.py ` script.
@@ -81,27 +69,22 @@ optional arguments:
8169The script can be run serially on a BIDS dataset or in parallel at subject/session level. The three methods of running
8270the script have been described below with example commands:
8371
84- <<<<<<< HEAD
8572For readability of example commands, the following bash variables have defined as follows:
8673
8774``` bash
8875INPUT_DIR=" <path/to/BIDS/input/dataset>"
8976OUTPUT_DIR=" <path/to/desired/defacing/output/directory>"
9077```
9178
92- ** NOTE:** In the example commands below, <path/to/BIDS/input/dataset> and <path/to/desired/output/directory> are
93- placeholders for paths to input and output directories respectively.
94- =======
9579** NOTE:** In the example commands below, ` <path/to/BIDS/input/dataset> ` and ` <path/to/desired/output/directory> ` are
9680placeholders for paths to input and output directories, respectively.
97- > > > > > > > 8dc705ab68bf38be986c6f33b50d80af46af7beb
9881
9982#### Option 1: Serially
10083
10184If you have a small dataset with less than 10 subjects, then it might be easiest to run the defacing algorithm serially.
10285
10386``` bash
104- python dsst_defacing_wf.py -i $INPUT_DIR -o $OUTPUT_DIR
87+ python dsst_defacing_wf.py -i ${ INPUT_DIR} -o ${ OUTPUT_DIR}
10588```
10689
10790#### Option 2: In parallel at subject level
0 commit comments