Skip to content

Commit

Permalink
more information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ccraddock committed Sep 13, 2013
1 parent f7cd06d commit 1fc8b72
Showing 1 changed file with 47 additions and 51 deletions.
98 changes: 47 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,52 @@
cluster_roi
===========

#### pyClusterROI_test.py
# Copyright (C) 2010 R. Cameron Craddock ([email protected])
#
# This script is a part of the pyClusterROI python toolbox for the spatially
# constrained clustering of fMRI data. It is a demonstration of how to use the
# toolbox and a regression test to make sure that the toolbox code works.
#
# For more information refer to:
#
# Craddock, R. C.; James, G. A.; Holtzheimer, P. E.; Hu, X. P. & Mayberg, H. S.
# A whole brain fMRI atlas generated via spatially constrained spectral
# clustering Human Brain Mapping, 2012, 33, 1914-1928 doi: 10.1002/hbm.21333.
#
# ARTICLE{Craddock2012,
# author = {Craddock, R C and James, G A and Holtzheimer, P E and Hu, X P and
# Mayberg, H S},
# title = {{A whole brain fMRI atlas generated via spatially constrained
# spectral clustering}},
# journal = {Human Brain Mapping},
# year = {2012},
# volume = {33},
# pages = {1914--1928},
# number = {8},
# address = {Department of Neuroscience, Baylor College of Medicine, Houston,
# TX, United States},
# pmid = {21769991},
# }
#
# Documentation, updated source code and other information can be found at the
# NITRC web page: http://www.nitrc.org/projects/cluster_roi/ and on github at
# https://github.com/ccraddock/cluster_roi
#
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
####


# this scripts requires NumPy (numpy.scipy.org), SciPy (www.scipy.org), and
# NiBabel (http://niftilib.sourceforge.net/pynifti/) and the pyClusterROI
# toolbox to be installed in a directory that is accessible through PythonPath
pyClusterROI_test.py
Copyright (C) 2010 R. Cameron Craddock ([email protected])

This script is a part of the pyClusterROI python toolbox for the spatially
constrained clustering of fMRI data. It is a demonstration of how to use the
toolbox and a regression test to make sure that the toolbox code works.

For more information refer to:

Craddock, R. C.; James, G. A.; Holtzheimer, P. E.; Hu, X. P. & Mayberg, H. S.
A whole brain fMRI atlas generated via spatially constrained spectral
clustering Human Brain Mapping, 2012, 33, 1914-1928 doi: 10.1002/hbm.21333.

ARTICLE{Craddock2012,
author = {Craddock, R C and James, G A and Holtzheimer, P E and Hu, X P and
Mayberg, H S},
title = {{A whole brain fMRI atlas generated via spatially constrained
spectral clustering}},
journal = {Human Brain Mapping},
year = {2012},
volume = {33},
pages = {1914--1928},
number = {8},
address = {Department of Neuroscience, Baylor College of Medicine, Houston,
TX, United States},
pmid = {21769991},
}

Documentation, updated source code and other information can be found at the
NITRC web page: http://www.nitrc.org/projects/cluster_roi/ and on github at
https://github.com/ccraddock/cluster_roi


This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

This library requires [NumPy](http://numpy.scipy.org), [SciPy](http://www.scipy.org), and [NiBabel](http://nipy.sourceforge.net/nibabel).

Please refer to pyClusterROI_test.py for detailed instructions on how to use the code. This script can be executed using [test data.](https://www.nitrc.org/frs/downloadlink.php/3719)

0 comments on commit 1fc8b72

Please sign in to comment.