Difference between revisions of "Freesurfer"

From UFRC
Jump to navigation Jump to search
m (Text replacement - "#uppercase" to "uc")
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Software]][[Category:Bioinformatics]][[Category:Neurology]]
+
[[Category:Software]][[Category:Bioinformatics]][[Category:Neurology]][[Category:Neuroimaging]]
 
{|<!--CONFIGURATION: REQUIRED-->
 
{|<!--CONFIGURATION: REQUIRED-->
 
|{{#vardefine:app|freesurfer}}
 
|{{#vardefine:app|freesurfer}}
Line 5: Line 5:
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
|{{#vardefine:exe|}}            <!--ADDITIONAL INFO-->
+
|{{#vardefine:exe|1}}            <!--ADDITIONAL INFO-->
 
|{{#vardefine:pbs|}}            <!--PBS SCRIPTS-->
 
|{{#vardefine:pbs|}}            <!--PBS SCRIPTS-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
Line 32: Line 32:
 
-->
 
-->
 
==System Variables==
 
==System Variables==
* HPC_{{#uppercase:{{#var:app}}}}_DIR and FREESURFER_HOME - installation directory
+
* HPC_{{uc:{{#var:app}}}}_DIR and FREESURFER_HOME - installation directory
* HPC_FREESURFER_BIN - executable directory
+
 
===Freesurfer configuration variables===
 
The following variables are preset by the {{#var:app}} module:
 
* SUBJECTS_DIR
 
* FUNCTIONALS_DIR
 
* FSFAST_HOME
 
* MNI_DIR
 
===Matlab configuration===
 
If you do intend to use the functional tools, then add these lines to your ~/matlab/startup.m file:
 
fsfasthome = getenv('FSFAST_HOME');
 
fsfasttoolbox = sprintf('%s/toolbox',fsfasthome);
 
path(path,fsfasttoolbox);
 
or load the ''freesurfer'' module and run
 
source $HPC_FREESURFER_DIR/SetUpFreeSurfer.sh
 
 
<!--Configuration-->
 
<!--Configuration-->
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==
Line 53: Line 40:
 
<!--Run-->
 
<!--Run-->
 
{{#if: {{#var: exe}}|==Additional Information==
 
{{#if: {{#var: exe}}|==Additional Information==
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
+
Starting with freesurfer/6.0.0 the software is available as a Singularity container. To run any executable use the 'launch_freesurfer' wrapper after loading the module.
 +
 
 +
E.g.
 +
 
 +
launch_freesurfer dcmunpack
 +
 
 +
'''NOTE:'''
 +
 
 +
Freesurfer comes with Freeview software. Freeview is a completely separate software from Freesurfer and is used purely for data visualization. Freesurfer 6 includes Freeview 2.0.
 +
 
 
|}}
 
|}}
 
<!--PBS scripts-->
 
<!--PBS scripts-->

Revision as of 21:20, 6 December 2019

Description

freesurfer website  

Freesurfer is a set of automated tools for reconstruction of the brain’s cortical surface from structural MRI data, and overlay of functional MRI data onto the reconstructed surface.

Required Modules

Serial

  • freesurfer

System Variables

  • HPC_FREESURFER_DIR and FREESURFER_HOME - installation directory


Additional Information

Starting with freesurfer/6.0.0 the software is available as a Singularity container. To run any executable use the 'launch_freesurfer' wrapper after loading the module.

E.g.

launch_freesurfer dcmunpack

NOTE:

Freesurfer comes with Freeview software. Freeview is a completely separate software from Freesurfer and is used purely for data visualization. Freesurfer 6 includes Freeview 2.0.



Citation

If you publish research that uses freesurfer you have to cite it as follows:

See [1] in the Freesurfer wiki on how to correctly cite Freesurfer tools.