Differences between revisions 28 and 29
Deletions are marked like this. Additions are marked like this.
Line 18: Line 18:
This program runs both dmri_groupByEndpoints and dmri_extractSurfaceMeasurements and the outputs will be under its respective section below
Line 30: Line 32:
The output directory will be filled with TRK files. Each TRK file will be labeled with the name of the region and each will be filled with streamlines that connect the region. See below:


Line 39: Line 45:

The output directory will be filled with CSV files. Each CSV file will be labeled with the name of the region and each will contain numerous metrics, such as thickness and curvature. If the -fa flag is used, an addition 2 or more column will contain the mean FA and standard deviation. See below:

'''WITH -FA FLAG'''



'''WITHOUT FLAG'''

Line 50: Line 66:
The new overlay files will be created in the same directory with the name that it was passed with. The overlay files will be completely blank (values are zero) besides the points near the beginning and end of the streamline passed in, which will have a value that was set before it was run. See below:
Line 57: Line 75:

The output will be 12 violin plots that will open on your desktop, each one containing 4 violins. On the left half, these two violins represent the left and right hemisphere of group 1, while the other two represent the left and right hemisphere of group 2. See below:

U-Shape Bundle Analysis

Note: all of the source code can be found on the "dmri" branch on the Freesurfer Github page. The link can be found here:

https://github.com/freesurfer/freesurfer/tree/dmri/anatomicuts

How to Run

Note by running the executable with no parameters will also give information on how to run the program

Main Bundle Analysis Program

Usage: ./bundleAnalysis.sh <Patient File> <OPTION: DTI>

DTI is an option that allows more metrics about the FA values to be outputted based on 4 volumes

This program runs both dmri_groupByEndpoints and dmri_extractSurfaceMeasurements and the outputs will be under its respective section below

If specific files are wanted to be used or files cannot be found, run the programs individually (read below)

Individually

Group by Endpoints

Usage: ./dmri_groupByEndpoints -s <streamlineFile> -i <imageFile> -d <outputDirectory>

The program will take in a streamline file and an image file, cluster the streamlines, and output TRK files to the output directory

Output

The output directory will be filled with TRK files. Each TRK file will be labeled with the name of the region and each will be filled with streamlines that connect the region. See below:

Extract Surface Measurements

Usage: ./dmri_extractSurfaceMeasurements -i <streamlineFile(s)> -sl <Left Hemisphere Surface> -tl <Left Thickness File> -cl <Left Curvature File> -sr <Right Hemisphere Surface> -tr <Right Thickness File> -cl <Right Curvature File> -o <outputDirectory>

OPTIONAL FLAG: -fa <number of Measures> <Given Name 1> <File 1> ... <Given Name X> <File X>

The program will take in streamlines, a full brain surface with overlay files, an output directory, and possibly image files, and will output surface metrics, such as thickness and curvature as well as FA at the endpoints of the streamlines

Output

The output directory will be filled with CSV files. Each CSV file will be labeled with the name of the region and each will contain numerous metrics, such as thickness and curvature. If the -fa flag is used, an addition 2 or more column will contain the mean FA and standard deviation. See below:

WITH -FA FLAG

WITHOUT FLAG

Additional Programs

Change Endpoints

Usage: ./dmri_changeEndpoints -i <streamlineFile> -sl <Left Hemisphere Surface> -sr <Right Hemisphere Surface> -ol <Left Overlay Filename> -or <Right Overlay Filename> -itk <Itk Volume File> -fs <FS Volume File>

The program will take in two volumes, a streamline, a surface, and the names of the overlay file that will be created. It will assign the endpoints of the streamline to a set number (usually a value of 1, but can be changed by adjusting the value of the variable at the top)

Output

The new overlay files will be created in the same directory with the name that it was passed with. The overlay files will be completely blank (values are zero) besides the points near the beginning and end of the streamline passed in, which will have a value that was set before it was run. See below:

Plots

Usage: python3 ./dmri_plots.py <inputDirectory> <Grouping CSV> <Structure Name>

The program will take in an input Directory (containing subject directories), a CSV files that divides the subjects into groups, and the name of a structure. For every subject, multiple violin plots are created to organize the data from every column of the structure's CSV file. The plot will be further explained below.

Output

The output will be 12 violin plots that will open on your desktop, each one containing 4 violins. On the left half, these two violins represent the left and right hemisphere of group 1, while the other two represent the left and right hemisphere of group 2. See below:

U-Shape Bundle Analysis (last edited 2019-08-09 15:18:12 by AlexZsikla)