froi: fs-fast roi

manual pages

technical documentation


NAME

combine_label -- takes two labels (three to come in the future) and combines them either by set intersection or union.

SYNOPSIS

combine_label -subjectname subjectname -inputlabel label1,label2 -outputlabel output_label -method <intersection|union> [-labelpath $SUBJECTS_DIR/label -force -help -man -debug]

DESCRIPTION

Much like with ROIs, it is sometimes useful to combine a two labels into one; for example, you might have labels for an anterior and posterior region and want to combine them into one label (label union). As well, you may have two vertices that you think overlap and you want to see if they do and to create a label that contains the overlaping vertices (label intersection). For example, this would be the case if you had an anatomical label (the fusiform gyrus) and you have a functional label (FFA) and want to know what vertices from the functional label lie within the anatomical label. combine_label allows the user to do this.

The default search path for labels is under /subjectdir/funcdir/roidir/label/. If you don't want this, provide the -labelpath command-line option. Note that if the directory does not exist it will be created.

The future goal is to have combine_label do the full suite of intersection, union, and overlap of 2-3 labels. At the moment, however, you can only do label intersection with two labels. Future work will implement the previous goal.

REQUIRED ARGUMENTS

-subjectname subjectname
Name of the subject to which these labels belong. Even if using your own label directory (i.e., not the label directory under $SUBJECTS_DIR), you need to give this parameter.

-inputlabel label1,label2
Name of the input labels, with or without the .label extension. Separate the labels with a comma only, no spaces between the comma and the next label.

-outputlabel outputlabel
Name of the output label, with or without the .label extension. The labe will be saved under $SUBJECTS_DIR/subjectname/label/ unless overridden by the -labelpath option.

-method intersect
Method of label combination. intersect does simple set intersection and is the only method currently supported.

OPTIONAL ARGUMENTS

-labelpath $SUBJECTS_DIR/subjectname/label
Path in which to look for labels, -labelpath defaults to the label directory under the subjectname. Change this if your labels are stored in a different location. Note that input labels will be read from this directory and the output label will be saved to this directory.

-force
If you attempt to run combine_label for an output label that has previously been created, the program will quit with an error, telling you of this situation. Use this parameter to override that behavior.

-help
Terse usage information.

-man
Complete usage information (this file).

-debug
Displays debugging information. Use this option to help debug unexpected behavior and when submitting a bug report.

LIMITATIONS

As described above, combine_label only works currently for the method ``intersection'' and for two labels.

BUGS

None known at the moment.

AUTHOR

Nicholas Knouf, <nknouf@mit.edu>, <nknouf@mimeme.net>

COPYRIGHT & LICENSE

Copyright (c) 2003, Nicholas Knouf, MIT.

This program is free software and is governed by the terms of the Artistic Licen se.

REVISION

$Id: combine_label,v 1.4 2003/10/06 16:03:46 nknouf Exp $

SEE ALSO

roi2label