TMD

Run all tox jobs using Python3 license codecov.io Documentation Status DOI

A python package for the topological analysis of neurons.

The TMD performs the topological analysis of neuronal morphologies and extracts the persistence barcodes of trees.

This Python module includes:

  • Basic loading of neuronal morphologies in swc and h5 file format.

  • Extraction of the topological descriptors of tree morphologies.

  • Visualization of neuronal trees and neurons.

  • Plotting persistence diagrams, barcodes and images.

Installation

This package should be installed using pip:

pip install TMD

For installation of optional viewers:

pip install TMD[viewer]

Usage

# Import the TMD toolkit in IPython
import tmd

# Load a neuron
neuron = tmd.io.load_neuron('input_path_to_file/input_file.swc')

# Extract the tmd of a neurite, i.e., neuronal tree
pd = tmd.methods.get_persistence_diagram(neuron.neurites[0])

Citation

If you use this software or method for your research, we kindly ask you to cite the following publication associated to this repository:

A Topological Representation of Branching Neuronal Morphologies

Cite this article as:

Kanari, L., Dłotko P., Scolamiero M., et al., A Topological Representation of Branching Neuronal Morphologies, Neuroinformatics 16, nᵒ 1 (2018): 3‑13. https://doi.org/10.1007/s12021-017-9341-1.

Funding & Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

For license and authors, see LICENSE.txt and AUTHORS.md respectively.

Copyright © 2021-2022 Blue Brain Project/EPFL