README.md 5.84 KB
Newer Older
Philipp Schubert's avatar
Philipp Schubert committed
1
[![Documentation Status](https://readthedocs.org/projects/syconn/badge/?version=latest)](https://syconn.readthedocs.io/en/latest/?badge=latest)
Philipp Schubert's avatar
Philipp Schubert committed
2
3
[![pipeline status](https://gitlab.mpcdf.mpg.de/pschuber/SyConn/badges/master/pipeline.svg)](https://gitlab.mpcdf.mpg.de/pschuber/SyConn/commits/master)
[![coverage report](https://gitlab.mpcdf.mpg.de/pschuber/SyConn/badges/master/coverage.svg)](https://gitlab.mpcdf.mpg.de/pschuber/SyConn/commits/master)
Philipp Schubert's avatar
Philipp Schubert committed
4
[![pylint status](https://gitlab.mpcdf.mpg.de/pschuber/SyConn/-/jobs/artifacts/master/raw/pylint/pylint.svg?job=pylint)](https://gitlab.mpcdf.mpg.de/pschuber/SyConn/-/jobs/artifacts/master/raw/pylint/pylint.log?job=pylint)
Philipp Schubert's avatar
Philipp Schubert committed
5

6
7
<img align="right" width="300"
src="./docs/_static/logo_SyConn.png"><br/>
Philipp Schubert's avatar
Philipp Schubert committed
8

Philipp Schubert's avatar
Philipp Schubert committed
9

Philipp Schubert's avatar
Philipp Schubert committed
10
11
SyConn
------
Philipp Schubert's avatar
Philipp Schubert committed
12
13
Refactored version of SyConn for automated synaptic connectivity inference based on dense EM segmentation data. For the first version
 see below or checkout the branch [dorkenwald2017nm](https://github.com/StructuralNeurobiologyLab/SyConn/tree/dorkenwald2017nm).
14

Philipp Schubert's avatar
Philipp Schubert committed
15
Current features:
16
17
- introduction of classes for handling of supervoxels (e.g. cell fragments, predicted cellular
organelles like mitochondria, vesicle clouds etc.) and agglomerated supervoxels
18
19
- prediction of sub-cellular structures, supervoxel extraction and mesh
  generation
20
- (sub-) cellular compartment (spines, bouton and axon/dendrite/soma) and cell type classification with multiview- [\[2\]](https://www.nature.com/articles/s41467-019-10836-3) and with skeleton-based approaches [\[1\]](https://www.nature.com/articles/nmeth.4206)
21
- glia identification and separation [\[2\]](https://www.nature.com/articles/s41467-019-10836-3)
22
23
- connectivity matrix export
- KNOSSOS plugin for interactive exploration (work in progress)
Philipp Schubert's avatar
Philipp Schubert committed
24

25
If you use parts of this code base in your academic projects, please cite the corresponding publication(s).
26

Philipp Schubert's avatar
Philipp Schubert committed
27

28
29
Documentation
-------------
30
The documentation for the refactored version is still work-in-progress and can be found [here](docs/doc.md). Alternatively and for API docs please refer to the latest [readthedocs build](https://syconn.readthedocs.io/en/latest/).
Philipp Schubert's avatar
Philipp Schubert committed
31

32
For SyConn v1, please refer to the old [documentation](https://structuralneurobiologylab.github.io/SyConn/documentation/). We also present more general information about SyConn on our [Website](https://structuralneurobiologylab.github.io/SyConn/).
33

Philipp Schubert's avatar
Philipp Schubert committed
34

35
36
The Team
--------
37
The Synaptic connectivity inference toolkit is currently developed at the Max-Planck-Institute of Neurobiology in Martinsried by
Philipp Schubert's avatar
Philipp Schubert committed
38
 Philipp Schubert, Jonathan Klimesch, Alexandra Rother and Joergen Kornfeld.
39
40


41
42
Acknowledgements
----------------
Philipp Schubert's avatar
Philipp Schubert committed
43
44
45
46
47
48
We are especially grateful for the support by Winfried Denk who enabled
this work in his department. We also want to thank Christian
Guggenberger and his group at the MPCDF for cluster support and deepmind
for providing egl extension code to handle multi-gpu rendering on the
same machine. The original code snippet (under the Apache License 2.0)
used for our project can be found
49
[here](https://github.com/deepmind/dm_control/blob/30069ac11b60ee71acbd9159547d0bc334d63281/dm_control/_render/pyopengl/egl_ext.py).
Philipp Schubert's avatar
Philipp Schubert committed
50
51
Thanks to Julia Kuhl (see http://somedonkey.com/ for more beautiful
work) for designing and creating the logo and to Rangoli Saxena, Mariana
Philipp Schubert's avatar
Philipp Schubert committed
52
53
Shumliakivska, Josef Mark, Maria Kawula, Atul Mohite, Carl Constantin v. Wedemeyer,
Gaurav Kumar and Martin Drawitsch for code contributions.
54
55


56
57
Publications
------------
58
\[1\] [Automated synaptic connectivity inference for volume electron microscopy](https://www.nature.com/articles/nmeth.4206)
59
```
Philipp Schubert's avatar
Philipp Schubert committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 @ARTICLE{SyConn2017,
   title     = "Automated synaptic connectivity inference for volume electron
                microscopy",
   author    = "Dorkenwald, Sven and Schubert, Philipp J and Killinger, Marius F
                and Urban, Gregor and Mikula, Shawn and Svara, Fabian and
                Kornfeld, Joergen",
   abstract  = "SyConn is a computational framework that infers the synaptic
                wiring of neurons in volume electron microscopy data sets with
                machine learning. It has been applied to zebra finch, mouse and
                zebrafish neuronal tissue samples.",
   journal   = "Nat. Methods",
   publisher = "Nature Publishing Group, a division of Macmillan Publishers Limited. All Rights Reserved.",
   year      = 2017,
   month     = Feb,
   day       = 27,
   url       = http://dx.doi.org/10.1038/nmeth.4206
 }
  ```
Philipp Schubert's avatar
Philipp Schubert committed
78

79
\[2\] [Learning cellular morphology with neural networks](https://doi.org/10.1038/s41467-019-10836-3)
80
81
82
83
84
85
86
87
88
89
90
91
92
  ```
  @Article{Schubert2019,
author={Schubert, Philipp J.
and Dorkenwald, Sven
and Januszewski, Michal
and Jain, Viren
and Kornfeld, Joergen},
title={Learning cellular morphology with neural networks},
journal={Nature Communications},
year={2019},
volume={10},
number={1},
pages={2736},
93
94
95
96
97
98
99
100
101
abstract={Reconstruction and annotation of volume electron microscopy data sets of brain tissue is challenging but
can reveal invaluable information about neuronal circuits. Significant progress has recently been made in automated
neuron reconstruction as well as automated detection of synapses. However, methods for automating the morphological
analysis of nanometer-resolution reconstructions are less established, despite the diversity of possible applications.
Here, we introduce cellular morphology neural networks (CMNs), based on multi-view projections sampled from automatically
reconstructed cellular fragments of arbitrary size and shape. Using unsupervised training, we infer morphology embeddings
(Neuron2vec) of neuron reconstructions and train CMNs to identify glia cells in a supervised classification paradigm,
which are then used to resolve neuron reconstruction errors. Finally, we demonstrate that CMNs can be used to identify
subcellular compartments and the cell types of neuron reconstructions.},
102
103
104
105
issn={2041-1723},
doi={10.1038/s41467-019-10836-3},
url={https://doi.org/10.1038/s41467-019-10836-3}
}
Philipp Schubert's avatar
Philipp Schubert committed
106
  ```