README.md 2.02 KB
Newer Older
1
# FSL-MRS
Saad Jbabdi's avatar
Saad Jbabdi committed
2
3


Saad Jbabdi's avatar
Saad Jbabdi committed
4
### Description
Saad Jbabdi's avatar
Saad Jbabdi committed
5

Saad Jbabdi's avatar
Saad Jbabdi committed
6
7
8
9
10
11
12
13
14
FSL-MRS is a collection of python modules and wrapper scripts for pre-processing and model fitting of Magnetic Resonance Spectroscopy (MRS) data.

---
### Installation 

    git clone https://git.fmrib.ox.ac.uk/saad/fsl_mrs.git
    cd fsl_mrs
    pip install .

William Clarke's avatar
William Clarke committed
15
16
17
18
19
20
#### Dependencies

    pip install spec2nii

After installation see the [quick start guide](https://users.fmrib.ox.ac.uk/~wclarke/fsl_mrs/userdoc/quick_start.html).

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

23
24
### Content

Saad Jbabdi's avatar
Saad Jbabdi committed
25
26
27
28
29
#### Scripts:

- **fsl\_mrs**
: fit a single spectrum 
- **fsl\_mrsi**
William Clarke's avatar
William Clarke committed
30
31
: fit a 3D volume of 1D spectra 
- **fsl\_mrs\_proc**
Saad Jbabdi's avatar
Saad Jbabdi committed
32
: pre-processing (coil combination, averaging, eddy-current correction) 
William Clarke's avatar
William Clarke committed
33
34
- **fsl\_mrs\_preproc**
: Pre-packaged processing for non-edited SVS. 
Saad Jbabdi's avatar
Saad Jbabdi committed
35
- **fsl\_mrs\_sim**
William Clarke's avatar
William Clarke committed
36
: simulate basis spectra
Saad Jbabdi's avatar
Saad Jbabdi committed
37
- **mrs_vis**
William Clarke's avatar
William Clarke committed
38
39
40
: quick visualisation of the spectra or basis spectra
- **svs_segment & mrsi_segment**
: Run tissue segmentation for SVS/MRSI from T1 image.
Saad Jbabdi's avatar
Saad Jbabdi committed
41
42
43

---

William Clarke's avatar
William Clarke committed
44
### Usage
Saad Jbabdi's avatar
Saad Jbabdi committed
45
46
47

For each of the wrapper scripts above, simply type `<name_of_script> --help` to get the usage.

William Clarke's avatar
William Clarke committed
48
49
50
Example command-line usage is demonstrated in the packaged [Jupyter Notebook](https://git.fmrib.ox.ac.uk/saad/fsl_mrs/-/blob/master/example_usage/Example%20SVS%20processing%20-%20command-line.ipynb.).

Documentation can be found online [here](https://users.fmrib.ox.ac.uk/~wclarke/fsl_mrs/userdoc/index.html).
Saad Jbabdi's avatar
Saad Jbabdi committed
51

William Clarke's avatar
William Clarke committed
52
### File types
Saad Jbabdi's avatar
Saad Jbabdi committed
53

William Clarke's avatar
William Clarke committed
54
FSL-MRS accepts FID data in NIfTI + JSON format. Some scripts can also read .RAW (LCModel) and text (jMRUI).
Saad Jbabdi's avatar
Saad Jbabdi committed
55

William Clarke's avatar
William Clarke committed
56
Conversion to NIfTI is provided by [spec2nii](https://github.com/wexeee/spec2nii).
Saad Jbabdi's avatar
Saad Jbabdi committed
57

William Clarke's avatar
William Clarke committed
58
### Working in python
Saad Jbabdi's avatar
Saad Jbabdi committed
59

William Clarke's avatar
William Clarke committed
60
61
62
If you don't want to use the wrapper scripts, you can use the python modules directly in your own python scripts/programs. Or in an interactive Python environment (see example [notebook](https://git.fmrib.ox.ac.uk/saad/fsl_mrs/-/blob/master/example_usage/Example%20SVS%20processing%20-%20interactive%20notebook.ipynb)) 

---
Saad Jbabdi's avatar
Saad Jbabdi committed
63

William Clarke's avatar
William Clarke committed
64
### Permissions and citations
Saad Jbabdi's avatar
Saad Jbabdi committed
65

William Clarke's avatar
William Clarke committed
66
If you use FSL-MRS in your research please cite:
Saad Jbabdi's avatar
Saad Jbabdi committed
67

William Clarke's avatar
William Clarke committed
68
Please see the LICENSE file for licensing information.
Saad Jbabdi's avatar
Saad Jbabdi committed
69
70
71
72