README.md 7.3 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

Shaun Warrington's avatar
Shaun Warrington committed
7
The script was written by Saad Jbabdi & Stamatios Sotiropoulos and slightly edited by 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
Saad Jbabdi's avatar
Saad Jbabdi committed
18

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

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

Saad Jbabdi's avatar
Saad Jbabdi committed
23

Shaun Warrington's avatar
Shaun Warrington committed
24
Warrington S, Bryant K, Charquero-Ballester M, Douaud G, Jbabdi S*, Mars R*, Sotiropoulos SN* (Submitted)
Saad Jbabdi's avatar
Saad Jbabdi committed
25
26
27
28
29
30
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
31
32
33

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

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

42
43

Usage:
Saad Jbabdi's avatar
Saad Jbabdi committed
44
45
46
47
48
49
50
51
    xtract -bpx <bedpostX_dir> -out <outputDir> -str <structuresFile> -p <protocolsFolder> [options]
    xtract -bpx <bedpostX_dir> -out <outputDir> -species HUMAN [options]
    xtract -bpx <bedpostX_dir> -out <outputDir> -species MACAQUE [options]

    Compulsory arguments:

       -bpx <folder>                     Path to bedpostx folder
       -out <folder>                     Path to output folder
52

Saad Jbabdi's avatar
Saad Jbabdi committed
53
54
55
56
57
58
59
60
61
       And EITHER:
       -str <file>                       Structures file (format: <tractName> [samples=1], 1 means 1000, '#' to skip lines)
       -p   <folder>                     Protocols folder (all masks in same standard space)

       Or:
       -species <SPECIES>                One of HUMAN or MACAQUE

    Optional arguments:

62
63
       -stdwarp <std2diff> <diff2std>    Standard2diff and Diff2standard transforms (Default=bedpostx_dir/xfms/{standard2diff,diff2standard})
       -gpu                              Use GPU version
Saad Jbabdi's avatar
Saad Jbabdi committed
64
65
       -native                           Run tractography in native (diffusion) space
       -res <mm>                         Output resolution (Default=same as in protocol folders unless '-native' used)
Stamatios Sotiropoulos's avatar
Stamatios Sotiropoulos committed
66
67
       -ptx_options <options.txt>	     Pass extra probtrackx2 options as a text file to override defaults, e.g. --steplength=0.2 --distthresh=10)

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
88
89
90
91
92
93
When running XTRACT with the '-species' option, a predefined list of tracts is automatically extracted. Currently the following tracts are available:

| **Tract**   | **Abbreviation** |
| --------| ------------ |
| Arcuate Fasciculus | AF |
| Acoustic Radiation | AR |
| Anterior Thalamic Radiation | ATR |
| Cingulum subsection : Dorsal | CBD |
Shaun Warrington's avatar
Shaun Warrington committed
94
| Cingulum subsection : Peri-genual | CBP |
Saad Jbabdi's avatar
Saad Jbabdi committed
95
96
97
98
99
100
101
102
103
| Cingulum subsection : Temporal | CBT |
| Corticospinal Tract | CST |
| Frontal Aslant | FA |
| Forceps Major | FMA |
| Forceps Minor | FMI |
| Fornix | FX |
| Inferior Longitudinal Fasciculus | ILF |
| Inferior Fronto-Occipital Fasciculus | IFO |
| Middle Cerebellar Peduncle | MCP |
Stamatios Sotiropoulos's avatar
Typo    
Stamatios Sotiropoulos committed
104
| Middle Longitudinal Fasciculus | MdLF |
Saad Jbabdi's avatar
Saad Jbabdi committed
105
106
107
108
109
110
111
| Optic Radiation | OR |
| Superior Thalamic Radiation | STR |
| Superior Longitudinal Fasciculus 1 | SLF1 |
| Superior Longitudinal Fasciculus 2 | SLF2 |
| Superior Longitudinal Fasciculus 3 | SLF3 |
| Anterior Commissure | AC |
| Uncinate Fasciculus | UF |
Saad Jbabdi's avatar
Saad Jbabdi committed
112
| Vertical Occipital Fasciculus | VOF |
Saad Jbabdi's avatar
Saad Jbabdi committed
113
114
115



Saad Jbabdi's avatar
Saad Jbabdi committed
116
117
---------------------------------------------------------------------

Saad Jbabdi's avatar
Saad Jbabdi committed
118
## Adding your own tracts:
Saad Jbabdi's avatar
Saad Jbabdi committed
119
120
121

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

122
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
123

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

Saad Jbabdi's avatar
Saad Jbabdi committed
126
**Compulsory**:
127
- seed.nii.gz : a seed mask
Saad Jbabdi's avatar
Saad Jbabdi committed
128

Saad Jbabdi's avatar
Saad Jbabdi committed
129
**Optional**:
Saad Jbabdi's avatar
Saad Jbabdi committed
130
131
132
133
134
135
- 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)
136
  if such an option is required a single "target.nii.gz" file is also expected
Saad Jbabdi's avatar
Saad Jbabdi committed
137

Saad Jbabdi's avatar
Saad Jbabdi committed
138
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
139
140


Saad Jbabdi's avatar
Saad Jbabdi committed
141
142
143
144
145
146
147
148
---------------------------------------------------------------------

## Visualising results with FSLEYES

The output of XTRACT is a folder that contrains 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

```
 __  _______ ____      _    ____ _____         _                        
149
 \ \/ /_   _|  _ \    / \  / ___|_   _| __   _(_) _____      _____ _ __
Saad Jbabdi's avatar
Saad Jbabdi committed
150
151
152
153
154
  \  /  | | | |_) |  / _ \| |     | |   \ \ / / |/ _ \ \ /\ / / _ \ '__|
  /  \  | | |  _ <  / ___ \ |___  | |    \ V /| |  __/\ V  V /  __/ |   
 /_/\_\ |_| |_| \_\/_/   \_\____| |_|     \_/ |_|\___| \_/\_/ \___|_|                                                                           


155
156
157
158
 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
159

160
     Compulsory arguments:
Saad Jbabdi's avatar
Saad Jbabdi committed
161

162
163
164
165
166
167
168
169
        -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
170

171
     Optional arguments:
Saad Jbabdi's avatar
Saad Jbabdi committed
172

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

175
176
        -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
177
178

```