Spinalcordtoolbox Save

Comprehensive and open-source library of analysis tools for MRI of the spinal cord.

Project README

Spinal Cord Toolbox ###################

|badge-releases| |badge-forum| |badge-mailing-list| |badge-stats| |badge-twitter| |badge-downloads| |badge-ci| |badge-doc| |badge-license|

.. |badge-releases| image:: https://img.shields.io/github/v/release/spinalcordtoolbox/spinalcordtoolbox :alt: Releases :target: https://github.com/spinalcordtoolbox/spinalcordtoolbox/releases

.. |badge-forum| image:: https://img.shields.io/discourse/status?label=forum&server=http%3A%2F%2Fforum.spinalcordmri.org :alt: User forum :target: https://forum.spinalcordmri.org/c/sct

.. |badge-mailing-list| image:: https://img.shields.io/badge/mailing%20list-Spinalcordmri.org-green.svg?style=flat :alt: Community mailing list :target: https://goo.gl/forms/Q425YRKwZP5tsExF2

.. |badge-downloads| image:: https://img.shields.io/github/downloads/spinalcordtoolbox/spinalcordtoolbox/total.svg :alt: Downloads :target: https://github.com/spinalcordtoolbox/spinalcordtoolbox/graphs/traffic

.. |badge-ci| image:: https://github.com/spinalcordtoolbox/spinalcordtoolbox/actions/workflows/tests.yml/badge.svg :alt: GitHub Actions CI :target: https://github.com/spinalcordtoolbox/spinalcordtoolbox/actions/workflows/tests.yml?query=branch%3Amaster

.. |badge-doc| image:: https://readthedocs.org/projects/spinalcordtoolbox/badge/ :alt: Documentation Status :target: https://spinalcordtoolbox.com

.. |badge-license| image:: https://img.shields.io/github/license/spinalcordtoolbox/spinalcordtoolbox :alt: License :target: https://github.com/spinalcordtoolbox/spinalcordtoolbox/blob/master/LICENSE

.. |badge-stats| image:: https://www.openhub.net/p/spinalcordtoolbox/widgets/project_thin_badge.gif :alt: Project Stats :target: https://www.openhub.net/p/spinalcordtoolbox

.. |badge-twitter| image:: https://img.shields.io/twitter/follow/spinaltoolbox.svg?style=social&label=Follow :alt: Twitter Follow :target: https://twitter.com/spinaltoolbox

Spinal Cord Toolbox (SCT) is a comprehensive, free and open-source set of command-line tools dedicated to the processing and analysis of spinal cord MRI data.

.. image:: https://raw.githubusercontent.com/spinalcordtoolbox/doc-figures/master/overview.png :alt: Overview of Spinal Cord Toolbox functionality :width: 800

Key Features

For a thorough introduction to SCT's features, please refer to our 2024 Review "Reproducible Spinal Cord Quantitative MRI Analysis with the Spinal Cord Toolbox <https://doi.org/10.2463/mrms.rev.2023-0159>__".

In summary:

  • Segmentation of the spinal cord and gray matter
  • Segmentation of pathologies (e.g. multiple sclerosis lesions)
  • Detection of anatomical highlights (e.g. ponto-medullary junction, spinal cord centerline, vertebral levels)
  • Registration to template, and deformation (e.g. straightening)
  • Motion correction for diffusion and functional MRI time series
  • Computation of quantitative MRI metrics (e.g. diffusion tensor imaging, magnetization transfer)
  • Texture analysis (e.g. grey level co-occurrence matrix)
  • Extraction of metrics within anatomical regions (e.g. white matter tracts)
  • Manual labeling and segmentation via a Graphical User Interface (GUI)
  • Warping field creation and application
  • NIFTI volume manipulation tools for common operations

Installation

For macOS and Linux users, the simplest way to install SCT is to download the latest release <https://github.com/spinalcordtoolbox/spinalcordtoolbox/releases>_, then launch the install script:

.. code::

./install_sct

For more complex installation setups (Windows users, Docker, FSLeyes integration), see the Installation <https://spinalcordtoolbox.com/en/latest/user_section/installation.html>_ page.

Usage

Once installed, there are three main ways to use SCT:

1. Command-line tools

The primary way to invoke SCT is through terminal commands. For example:

.. code-block:: console

$ sct_deepseg_sc -i t2.nii.gz -c t2

Cropping the image around the spinal cord... Normalizing the intensity... Segmenting the spinal cord using deep learning on 2D patches... Reassembling the image... Resampling the segmentation to the native image resolution using linear interpolation... Binarizing the resampled segmentation... Compute shape analysis: 100%|################| 55/55 [00:00<00:00, 106.05iter/s]

Done! To view results, type: fsleyes t2.nii.gz -cm greyscale t2_seg.nii.gz -cm red -a 70.0 &

For a full overview of the available commands, see the Command-Line Tools <https://spinalcordtoolbox.com/user_section/command-line.html>_ page.

2. Multi-command pipelines

To facilitate multi-subject analyses, commands can be chained together to build processing pipelines. The best starting point for constructing a typical pipeline is the batch_processing.sh <https://spinalcordtoolbox.com/en/latest/user_section/getting-started.html#batch-processing-example>_ script, which is provided with your installation of SCT.

3. GUI (FSLeyes integration)

SCT provides a graphical user interface via a FSLeyes plugin. For more details, see the FSLeyes Integration <https://spinalcordtoolbox.com/en/latest/user_section/fsleyes.html>_ page.

Who is using SCT?

SCT is trusted by the research labs of many highly-regarded institutions worldwide. A full list of endorsements can be found on the Testimonials <https://spinalcordtoolbox.com/en/latest/overview/testimonials.html>_ page.

For a list of neuroimaging studies that depend on SCT, visit the Studies using SCT <https://spinalcordtoolbox.com/en/latest/overview/studies.html>_ page.

Contact

If you have any questions or concerns, and would like to get in touch with the developers of Spinal Cord Toolbox, the best way to do so is via the Spinalcordmri.org forum <https://forum.spinalcordmri.org/c/sct/8>_.

If you would like to stay up to date on spinal cord workshops and SCT announcements (new releases, hands-on courses, etc.), please subscribe to the Spinalcordmri.org mailing list <https://goo.gl/forms/Q425YRKwZP5tsExF2>_.

License

SCT is made available under the LGPLv3 license. For more details, see LICENSE <https://github.com/spinalcordtoolbox/spinalcordtoolbox/blob/master/LICENSE>_.

Contributing

We happily welcome contributions. Please see the Contributing <https://github.com/spinalcordtoolbox/spinalcordtoolbox/wiki/Contributing>_ page of the developer Wiki for more information.

.. warning:: ️Medical Disclaimer

All content found in the Spinal Cord Toolbox repository and spinalcordtoolbox.com website, including: text, images, audio, or other formats were created for informational purposes only. The content is not intended to be a substitute for professional medical advice, diagnosis, or treatment. Always seek the advice of your physician or other qualified health provider with any questions you may have regarding a medical condition. Never disregard professional medical advice or delay in seeking it because of something you have read on this website.

If you think you may have a medical emergency, call your doctor, go to the emergency department, or call your local emergency number immediately. Spinal Cord Toolbox does not recommend or endorse any specific tests, physicians, products, procedures, opinions, or other information that may be mentioned on spinalcordtoolbox.com. Reliance on any information provided by spinalcordtoolbox.com, Spinal Cord Toolbox contributors, contracted writers, or medical professionals presenting content for publication to spinalcordtoolbox.com is solely at your own risk.

Open Source Agenda is not affiliated with "Spinalcordtoolbox" Project. README Source: spinalcordtoolbox/spinalcordtoolbox
Stars
185
Open Issues
309
Last Commit
3 weeks ago

Open Source Agenda Badge

Open Source Agenda Rating