README.md 11.1 KB
Newer Older
Saad Jbabdi's avatar
Saad Jbabdi committed
1
## XTRACT - a command-line tool for automated tractography
Saad Jbabdi's avatar
Saad Jbabdi committed
2

3
4
XTRACT can be used to automatically extract a set of carefully dissected tracts in humans and macaques (other
species to come). It can also be used to define one's own tractography protocols where all the user needs to do is to
Saad Jbabdi's avatar
Saad Jbabdi committed
5
define a set of masks in standard space (e.g. MNI152)
Saad Jbabdi's avatar
Saad Jbabdi committed
6

7
The script was written by Saad Jbabdi, Stamatios Sotiropoulos & Shaun Warrington
Saad Jbabdi's avatar
Saad Jbabdi committed
8
(based on the autoPtx tool by Marius de Groot - see https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/AutoPtx)
Saad Jbabdi's avatar
Saad Jbabdi committed
9

Saad Jbabdi's avatar
Saad Jbabdi committed
10
11
12
13
14
15
16
The tractography protocols were created by:

Rogier Mars & Stamatios Sotiropoulos

with help from:
Saad Jbabdi, Kathryn Bryant, Shaun Warrington, Marina Charquero-Ballester, Gwenaelle Douaud

Saad Jbabdi's avatar
Saad Jbabdi committed
17
The XTRACT viewer helper script was written by Shaun Warrington
Shaun Warrington's avatar
Shaun Warrington committed
18
The XTRACT stats helper script was written by Shaun Warrington
Saad Jbabdi's avatar
Saad Jbabdi committed
19

Saad Jbabdi's avatar
Saad Jbabdi committed
20
---------------------------------------------------------------------
Saad Jbabdi's avatar
Saad Jbabdi committed
21
22

## Citations:
Saad Jbabdi's avatar
Saad Jbabdi committed
23

Saad Jbabdi's avatar
Saad Jbabdi committed
24

Shaun Warrington's avatar
Shaun Warrington committed
25
Warrington S, Bryant K, Charquero-Ballester M, Douaud G, Jbabdi S*, Mars R*, Sotiropoulos SN* (Submitted)
Saad Jbabdi's avatar
Saad Jbabdi committed
26
27
28
29
30
31
Standardised protocols for automated tractography and connectivity blueprints in the human and macaque brain.

de Groot M; Vernooij MW. Klein S, Ikram MA, Vos FM, Smith SM, Niessen WJ, Andersson JLR (2013)
Improving alignment in Tract-based spatial statistics: Evaluation and optimization of image registration.
NeuroImage, 76(1), 400-411. DOI: 10.1016/j.neuroimage.2013.03.015

Saad Jbabdi's avatar
Saad Jbabdi committed
32
33
34

---------------------------------------------------------------------

35
## Usage:
Saad Jbabdi's avatar
Saad Jbabdi committed
36
```
37
 __  _______ ____      _    ____ _____
Saad Jbabdi's avatar
Saad Jbabdi committed
38
39
40
41
42
 \ \/ /_   _|  _ \    / \  / ___|_   _|
  \  /  | | | |_) |  / _ \| |     | |  
  /  \  | | |  _ <  / ___ \ |___  | |  
 /_/\_\ |_| |_| \_\/_/   \_\____| |_|  

43

44
45
46
 Usage:
     xtract -bpx <bedpostX_dir> -out <outputDir> -species <SPECIES> [options]
     xtract -list
Saad Jbabdi's avatar
Saad Jbabdi committed
47

48
     Compulsory arguments:
Saad Jbabdi's avatar
Saad Jbabdi committed
49

50
51
52
        -bpx <folder>                          Path to bedpostx folder
        -out <folder>                          Path to output folder
        -species <SPECIES>                     One of HUMAN or MACAQUE
Stamatios Sotiropoulos's avatar
Stamatios Sotiropoulos committed
53

54
     Optional arguments:
55
56
57
58
59
60
61
62
63
64
65
66
67
        -list                                  List the tract names used in XTRACT
        -str <file>                            Structures file (format: <tractName> per line OR format: <tractName> [samples=1], 1 means 1000, '#' to skip lines)
        -p <folder>                            Protocols folder (all masks in same standard space) (Default=$FSLDIR/etc/xtract_data/<SPECIES>)
        -stdwarp <std2diff> <diff2std>         Standard2diff and Diff2standard transforms (Default=bedpostx_dir/xfms/{standard2diff,diff2standard})
        -gpu                                   Use GPU version
        -res <mm>                              Output resolution (Default=same as in protocol folders unless '-native' used)
        -ptx_options <options.txt>	           Pass extra probtrackx2 options as a text file to override defaults, e.g. --steplength=0.2 --distthresh=10)

        And EITHER:
        -native                                Run tractography in native (diffusion) space

        OR:
        -ref <refimage> <diff2ref> <ref2diff>  Reference image for running tractography in reference space, Diff2Reference and Reference2Diff transforms
Saad Jbabdi's avatar
Saad Jbabdi committed
68

Saad Jbabdi's avatar
Saad Jbabdi committed
69
```
Saad Jbabdi's avatar
Saad Jbabdi committed
70
71
---------------------------------------------------------------------

Saad Jbabdi's avatar
Saad Jbabdi committed
72
## Running XTRACT:
73
74
  XTRACT automatically detects if $SGE_ROOT is set and if so uses FSL_SUB.
  For optimal performance, use the GPU version!!!!
Saad Jbabdi's avatar
Saad Jbabdi committed
75
76
77

---------------------------------------------------------------------

Saad Jbabdi's avatar
Saad Jbabdi committed
78
## Atlases:
Saad Jbabdi's avatar
Saad Jbabdi committed
79
80
81
82

- For HUMAN, XTRACT uses the MNI152 standard space in $FSLDIR/etc/standard

- For MACAQUE, XTRACT uses the F99 atlas in Caret - see http://brainvis.wustl.edu/wiki/index.php/Caret:Atlases
83

Saad Jbabdi's avatar
Saad Jbabdi committed
84
  We also provide a copy of the F99 atlas in $FSLDIR/etc/xtract_data/standard/F99. This includes a helper script for registering your own diffusion/structural data to the F99 altas
Saad Jbabdi's avatar
Saad Jbabdi committed
85

Saad Jbabdi's avatar
Saad Jbabdi committed
86
87
When running XTRACT with the '-species' option, a predefined list of tracts is automatically extracted. Currently the following tracts are available:

88
| **Tract**   | **Abbreviation** | **XTRACT tractName** |
89
| -------- | ------------ | ------------ |
90
91
92
93
94
95
96
97
| Arcuate Fasciculus | AF | af_l   af_r |
| Acoustic Radiation | AR | ar_l   ar_r |
| Anterior Thalamic Radiation | ATR | atr_l   atr_r |
| Cingulum subsection : Dorsal | CBD | cbd_l   cbd_r |
| Cingulum subsection : Peri-genual | CBP | cbp_l   cbp_r |
| Cingulum subsection : Temporal | CBT | cbt_l   cbt_r |
| Corticospinal Tract | CST | cst_l   cst_r |
| Frontal Aslant | FA | fa_l   fa_r |
98
99
| Forceps Major | FMA | fma |
| Forceps Minor | FMI | fmi |
100
101
102
| Fornix | FX | fx_l   fx_r |
| Inferior Longitudinal Fasciculus | ILF | ilf_l   ilf_r |
| Inferior Fronto-Occipital Fasciculus | IFO | ifo_l   ifo_r |
103
| Middle Cerebellar Peduncle | MCP | mcp |
104
| Middle Longitudinal Fasciculus | MdLF | mdlf_l   mdlf_r |
105
| Optic Radiation | OR | or_l or_r |
106
107
108
109
| Superior Thalamic Radiation | STR | str_l   str_r |
| Superior Longitudinal Fasciculus 1 | SLF1 | slf1_l   slf1_r |
| Superior Longitudinal Fasciculus 2 | SLF2 | slf2_l   slf2_r |
| Superior Longitudinal Fasciculus 3 | SLF3 | slf3_l   slf3_r |
110
| Anterior Commissure | AC | ac |
111
112
| Uncinate Fasciculus | UF | uf_l   uf_r |
| Vertical Occipital Fasciculus | VOF | vof_l   vof_r |
113
114
115

You can run a subset of these tracts by providing a structure text file using the format:

116
tractName, per line (default number of seeds taken from default structure file)
117
118
119

OR

120
tractName nsamples, per line
121
122

For an example, see $FSLDIR/etc/xtract_data/Human/structureList
Saad Jbabdi's avatar
Saad Jbabdi committed
123

Saad Jbabdi's avatar
Saad Jbabdi committed
124
125
---------------------------------------------------------------------

Saad Jbabdi's avatar
Saad Jbabdi committed
126
## Adding your own tracts:
Saad Jbabdi's avatar
Saad Jbabdi committed
127
128
129

Suppose you want to create an automated protocol for a tract called 'mytrack'.  

130
First you need to create a folder called 'mytrack' which you can add e.g. in the protocols folder.
Saad Jbabdi's avatar
Saad Jbabdi committed
131

132
Then create the following NIFTI files (with this exact naming) and copy them into 'mytrack':
Saad Jbabdi's avatar
Saad Jbabdi committed
133

Saad Jbabdi's avatar
Saad Jbabdi committed
134
**Compulsory**:
135
- seed.nii.gz : a seed mask
Saad Jbabdi's avatar
Saad Jbabdi committed
136

Saad Jbabdi's avatar
Saad Jbabdi committed
137
**Optional**:
Saad Jbabdi's avatar
Saad Jbabdi committed
138
139
140
141
142
143
- stop.nii.gz    : a stop mask if required
- exclude.nii.gz : an exclusion mask if required
- ONE of the following:
  - target.nii.gz  :  a single target mask  
  - target1.nii.gz, target2.nii.gz, etc. : a number of targets, in which case streamlines will be kept if they cross ALL of them
- invert (empty file to indicate that a seed->target and target->seed run will be added and combined)
144
  if such an option is required a single "target.nii.gz" file is also expected
Saad Jbabdi's avatar
Saad Jbabdi committed
145

Saad Jbabdi's avatar
Saad Jbabdi committed
146
All the masks above should be in standard space (e.g. MNI152 or F99) if you want to run the same tracking for a collection of subjects.
Saad Jbabdi's avatar
Saad Jbabdi committed
147

148
Next, make a structure file using the format <tractName> <nsamples> per line and call XTRACT using -species <SPECIES> -str <file> -p <folder>, pointing to your new protocols folder 'mytrack'.
Saad Jbabdi's avatar
Saad Jbabdi committed
149

Saad Jbabdi's avatar
Saad Jbabdi committed
150
151
152
153
---------------------------------------------------------------------

## Visualising results with FSLEYES

154
The output of XTRACT is a folder that contains tracts in separate folders. We provide a convenient script that can load these tracts (or a subset of the tracts) into FSLEYES using different colours for the different tracts but matching the left/right colours
Saad Jbabdi's avatar
Saad Jbabdi committed
155
156
157

```
 __  _______ ____      _    ____ _____         _                        
158
 \ \/ /_   _|  _ \    / \  / ___|_   _| __   _(_) _____      _____ _ __
Saad Jbabdi's avatar
Saad Jbabdi committed
159
160
161
162
163
  \  /  | | | |_) |  / _ \| |     | |   \ \ / / |/ _ \ \ /\ / / _ \ '__|
  /  \  | | |  _ <  / ___ \ |___  | |    \ V /| |  __/\ V  V /  __/ |   
 /_/\_\ |_| |_| \_\/_/   \_\____| |_|     \_/ |_|\___| \_/\_/ \___|_|                                                                           


164
165
166
167
 Usage:
     xtract_viewer -dir <xtractDir> -species HUMAN [options]
     xtract_viewer -dir <xtractDir> -species MACAQUE [options]
     xtract_viewer -dir <xtractDir> -brain <PATH> [options]
Saad Jbabdi's avatar
Saad Jbabdi committed
168

169
     Compulsory arguments:
Saad Jbabdi's avatar
Saad Jbabdi committed
170

171
172
173
174
175
176
177
178
        -dir <FOLDER>                     Path to XTRACT output folder

        And EITHER:
        -species <SPECIES>                One of HUMAN or MACAQUE

        OR:
        -brain <PATH>                     The brain image to use for the background overlay - must be in the same space as tracts.
                                          Default is the FSL_HCP065_FA map for HUMAN and F99 T1 brain for MACAQUE
Saad Jbabdi's avatar
Saad Jbabdi committed
179

180
     Optional arguments:
Saad Jbabdi's avatar
Saad Jbabdi committed
181

182
        -str STRUCTURE,STRUCTURE,...      Structures (comma separated (default = display all that is found in input folder)
Saad Jbabdi's avatar
Saad Jbabdi committed
183

184
185
        -thr NUMBER NUMBER                The lower and upper thresholds applied to the tracts for viewing
                                          Default = 0.001 0.1
Saad Jbabdi's avatar
Saad Jbabdi committed
186
187

```
Shaun Warrington's avatar
Shaun Warrington committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

---------------------------------------------------------------------

## Extracting tract-wise summary statistics

A common usage of the XTRACT output is to summarise tracts in terms of simple summary statistics, such as their volume and microstructural properties (e.g. mean FA). We provide XTRACT stats to get such summary statistics in a quick and simple way.

You can use XTRACT stats with any modelled diffusion data, e.g. DTI, bedpostx, DKI.

Simply provide; the directory (and basename of files, if any) leading to the diffusion data of interest, the directory containing the XTRACT output, the warp field (or use 'native' if tracts are already in diffusion space). If tracts are not in diffusion space, you must also provide a reference image in diffusion space (e.g. FA map).

e.g. call: xtract_stats -d /home/DTI/dti_ -xtract /home/xtract -w /home/warp/standard2diff -r /home/DTI/dti_FA

The output (a .csv file) by default contains the tract volume (mm3) and the mean, median and standard deviation of the probability, length, FA and MD for each tract.

```
__  _______ ____      _    ____ _____    _        _
\ \/ /_   _|  _ \    / \  / ___|_   _|__| |_ __ _| |_ ___
 \  /  | | | |_) |  / _ \| |     | |/ __| __/ _  | __/ __|
 /  \  | | |  _ <  / ___ \ |___  | |\__ \ || (_| | |_\__ \\
/_/\_\ |_| |_| \_\/_/   \_\____| |_||___/\__\__ _|\__|___/


Usage:
    xtract_stats -d <dir_basename> -xtract <XTRACT_dir> -w <xtract2diff> [options]

    Compulsory arguments:

       -d <folder_basename>                   Path to microstructure folder and basename of data (e.g. /home/DTI/dti_)
       -xtract <folder>                       Path to XTRACT output folder
       -w <xtract2diff>                       EITHER XTRACT results to diffusion space transform OR 'native' if tracts are already in diffusion space

    Optional arguments:
       -r <reference>                         If not 'native', provide reference image in diffusion space (e.g. /home/DTI/dti_FA)
       -out <path>                            Output filepath (Default <XTRACT_dir>/stats.csv)
       -str <file>                            Structures file (as in XTRACT) (Default is all tracts under <XTRACT_dir>)
       -thr <float>                           Threshold applied to tract probability map (default = 0.001 = 0.1%)

       -meas <list>                           Comma separated list of features to extract (Default = vol,prob,length,FA,MD - assumes DTI folder has been provided)
                                              vol = tract volume, prob = tract probability, length = tract length
                                              Additional metrics must follow file naming conventions. e.g. for dti_L1 use 'L1'

       -keepfiles                             Keep temporary files

```