Difference between revisions of "FSnormals.py"

From MEG Core
Jump to navigation Jump to search
Line 7: Line 7:
 
==Usage==
 
==Usage==
   
  +
FSnormals.py [-q] [-a annotation] ... [-t ortho+orig] [-i fac] [-p parcfile]
FSnormals.py subject [surface]
 
  +
[-r thresh] [-L|-R|-B] -o outputfile subject [surface]
   
The subject argument corresponds to the FreeSurfer subject designation, and denotes a directory under $SUBJECTS_DIR. The surface argument denotes the surface to use: pial, white, or smoothwm.
+
The subject argument corresponds to the FreeSurfer subject designation, and denotes a directory under $SUBJECTS_DIR. The surface argument denotes the surface to use: orig, pial, white, or smoothwm (default).
 
Other options:
 
Other options:
 
{|
 
{|
Line 15: Line 16:
 
| style="width: 10em" | -q || Operate quietly, default is verbose
 
| style="width: 10em" | -q || Operate quietly, default is verbose
 
|- valign="top"
 
|- valign="top"
| -a annotation || Restrict the output to a single annotation region, denoted by its number (see the corresponding ctab for a list of numbers and regions in the label/ directory of each subject's FreeSurfer directory). To select multiple regions, repeat this command. Note that positive numbers denote the left hemisphere, and negative numbers denote the right.
+
| -a annotation || Restrict the output to an annotation region, denoted by its number (see the corresponding ctab for a list of numbers and regions in the label/ directory of each subject's FreeSurfer directory). To select multiple regions, repeat this option. Note that in the output, positive numbers denote the left hemisphere, and negative numbers denote the right. The -L, -R, and -B options control which values (positive, negative, or both) appear in the output.
 
|- valign="top"
 
|- valign="top"
|-p parcfile|| Specify the parcellation file to use. The default is aparc.a2009s, which is the Destrieux atlas. Other options include aparc (the Desikan-Killiany atlas) and aparc.DKTatlas (the Desikan-Killiany-Tourville atlas).
+
|-p parcfile || Specify the parcellation file to use. The default is aparc.a2009s, which is the Destrieux atlas. Other options include aparc (the Desikan-Killiany atlas) and aparc.DKTatlas (the Desikan-Killiany-Tourville atlas).
 
|- valign="top"
 
|- valign="top"
| -t ortho+orig|| Rotate the output vertices and surface normals into the space defined by the ortho+orig space, in order to use this, ortho+orig must have been generated using the 3dTagAlign command.
+
| -t ortho+orig || Rotate the output vertices and surface normals into the space defined by the ortho+orig space. In order to use this, ortho+orig must have been generated using the 3dTagAlign command (typically using orthohull).
 
|- valign="top"
 
|- valign="top"
| -I <fac> || Inflate each vertex according to v' = v + fac * n (-I .001 is 1mm)
+
| -i <fac> || Inflate each vertex according to v' = v + fac * n (-i .001 is 1 mm)
 
|- valign="top"
 
|- valign="top"
 
| -r <thresh> || Use this option to filter out vertices which have near radial normals. The threshold is the absolute value of the dot product of the vertex's position vector (relative to the centroid) with the normal vector, so it ranges from 0 to 1. Large values allow more radial normals, small values (e.g. -r 0.2) pass only more tangential normals.
 
| -r <thresh> || Use this option to filter out vertices which have near radial normals. The threshold is the absolute value of the dot product of the vertex's position vector (relative to the centroid) with the normal vector, so it ranges from 0 to 1. Large values allow more radial normals, small values (e.g. -r 0.2) pass only more tangential normals.
 
|- valign="top"
 
|- valign="top"
| -L, -R, -B || -L or -R means just output the left or right hemisphere, respectively. The default is -B, which will output both.
+
| -L, -R, -B || -L or -R means just output the left or right hemisphere, respectively. The default is -B, which will output both. Note that a positive annotation value (See -a above) will still specify a right hemisphere region, if -R or -B is used.
 
|- valign="top"
 
|- valign="top"
| -o outputfule || Specify an output prefix to use. Otherwise, the output defaults to aparc.a2009s.norm, or whatever parcellation is specified by -p.
+
| -o outputfile || Specify an output filename to use.
 
|}
 
|}
   
 
==Output Files==
 
==Output Files==
   
The output of FSnormals.py is a single text file, stored in the label subdirectory of the subject's FreeSurfer directory. Each line of the file is a single vertex, and contains seven columns: vx, vy, vz, nx, ny, nz, annot. v x, y, and z are the coordinates in meters. nx, ny, and nz denote the normal vectors. The last number is the annotation or region number, negative for left hemisphere and positive for right.
+
The output of FSnormals.py is a single text file. Each line of the file is a single vertex, and contains seven columns: vx, vy, vz, nx, ny, nz, annot. vx, vy, and vz are the coordinates in meters. nx, ny, and nz denote the normal vector for that vertex. The last number is the annotation or region number, positive for left hemisphere and negative for right.

Revision as of 18:38, 9 July 2019

Return to Source Localization - SAM

Description

The FSnormals.py program will take a FreeSurfer surface, and output a list of all the vertices and their surface normals. Crucially, given an image in ortho/MEG space, as produced by AFNI's 3dTagAlign or orthohull.py, FSnormals.py will rotate the surface normals to MEG space. This program is required for use before sam_coreg can be run. Python must be installed. In addition, you must set the FREESURFER_HOME directory and, optionally, the SUBJECTS_DIR. Note that the default SUBJECTS_DIR is $FREESURFER_HOME/subjects, which is probably not where your images are. In addition to producing the surface normals, FSnormals.py will also preserve the annotation from freesurfer which gives the cortical parcel that any given vertex belongs to.

Usage

 FSnormals.py [-q] [-a annotation] ... [-t ortho+orig] [-i fac] [-p parcfile]
              [-r thresh] [-L|-R|-B] -o outputfile subject [surface]

The subject argument corresponds to the FreeSurfer subject designation, and denotes a directory under $SUBJECTS_DIR. The surface argument denotes the surface to use: orig, pial, white, or smoothwm (default). Other options:

-q Operate quietly, default is verbose
-a annotation Restrict the output to an annotation region, denoted by its number (see the corresponding ctab for a list of numbers and regions in the label/ directory of each subject's FreeSurfer directory). To select multiple regions, repeat this option. Note that in the output, positive numbers denote the left hemisphere, and negative numbers denote the right. The -L, -R, and -B options control which values (positive, negative, or both) appear in the output.
-t ortho+orig Rotate the output vertices and surface normals into the space defined by the ortho+orig space. In order to use this, ortho+orig must have been generated using the 3dTagAlign command (typically using orthohull).
-i <fac> Inflate each vertex according to v' = v + fac * n (-i .001 is 1 mm)
-r <thresh> Use this option to filter out vertices which have near radial normals. The threshold is the absolute value of the dot product of the vertex's position vector (relative to the centroid) with the normal vector, so it ranges from 0 to 1. Large values allow more radial normals, small values (e.g. -r 0.2) pass only more tangential normals.
-L, -R, -B -L or -R means just output the left or right hemisphere, respectively. The default is -B, which will output both. Note that a positive annotation value (See -a above) will still specify a right hemisphere region, if -R or -B is used.
-o outputfile Specify an output filename to use.

Output Files

The output of FSnormals.py is a single text file. Each line of the file is a single vertex, and contains seven columns: vx, vy, vz, nx, ny, nz, annot. vx, vy, and vz are the coordinates in meters. nx, ny, and nz denote the normal vector for that vertex. The last number is the annotation or region number, positive for left hemisphere and negative for right.