bombcell
Manual curation of electrophysiology spike sorted units is slow, laborious, and hard to standardize and reproduce. Bombcell is a powerful toolbox that addresses this problem, evaluating the quality of recorded units and extracting essential electrophysiological properties. Bombcell can replace manual curation or can be used as a tool to aid manual curation. See this talk at the annual Neuropixels course about quality control.
Documentation and guides to using and troubleshooting bombcell can be found on the dedicated wiki.
Below is a flowchart of how bombcell evaluates and classifies each unit:
Bombcell extracts relevant quality metrics to categorize units into four categories: single somatic units, multi-units, noise units and non-somatic units.
Take a look at bombcell_pipeline
to see an example workflow and play around with our small toy dataset. You can also use the MATLAB live script gettingStarted
Bombcell requires MATLAB>=2019a.
To begin using Bombcell:
- clone the repository and the dependencies.
- add bombcell's and the dependancies' folders to MATLAB's path.
- in addition, if you want to compute ephys properties, change your working directory to
bombcell\+bc\+ep\+helpers
in matlab and runmex -O CCGHeart.c
to able to compute fast ACGs, using part of the FMAToolbox.
- npy-matlab, to load .npy data in.
- If you have z-lib compressed ephys data, compressed with mtscomp, you will need the zmat toolbox. More information about compressing ephys data here.
- prettify-matlab, to make plots pretty.
- MATLAB toolboxes:
- Signal Processing Toolbox
- Image Processing Toolbox
- Statistics and Machine Learning Toolbox
- Parallel Computing Toolbox
In addition we would like to acknowledge:
- to compute fast ACGs, we use a function (
CCGHeart.c
) part of the FMAToolbox, and it is already included in bombcell.
If you find Bombcell useful in your work, we kindly request that you cite:
Julie M.J. Fabre, Enny H. van Beest, Andrew J. Peters, Matteo Carandini, & Kenneth D. Harris. (2023). Bombcell: automated curation and cell classification of spike-sorted electrophysiology data. Zenodo. https://doi.org/10.5281/zenodo.8172821
🌟 You can additionally star this repository using the top-right ⭐ button to help it gain more visibility.
Bombcell is under the open-source copyleft GNU General Public License 3. You can run, study, share, and modify the software under the condition that you keep and do not modify the license.
If you run into any issues or if you have any suggestions, please raise a github issue or create a pull request. You can email us: juliemfabre[at]gmail[dot]com, but github issues are preferred. You can also use the Neuropixels slack workgroup.
Zitieren als
Fabre, Julie M. J., et al. Bombcell: Automated Curation and Cell Classification of Spike-Sorted Electrophysiology Data. Zenodo, 2023, doi:10.5281/ZENODO.8172821.
Kompatibilität der MATLAB-Version
Plattform-Kompatibilität
Windows macOS LinuxKategorien
Tags
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Live Editor erkunden
Erstellen Sie Skripte mit Code, Ausgabe und formatiertem Text in einem einzigen ausführbaren Dokument.
decompressData
ephysProperties
ephysProperties/helpers
loading
personal_work_in_progress
personal_work_in_progress/preprocessing
personal_work_in_progress/uncompressData
prettify-matlab/examples
prettify-matlab/playground
prettify-matlab/prettify_code
prettify-matlab/prettify_colors
prettify-matlab/prettify_plot
prettify-matlab/prettify_stats
qualityMetrics
qualityMetrics/helpers
qualityMetrics/helpers/previous
qualityMetrics/toTry
recordingUtilities/generateChannelMaps
recordingUtilities/generateIMROfiles
visualizationTools
visualizationTools/helpers
Version | Veröffentlicht | Versionshinweise | |
---|---|---|---|
1.6.0 | See release notes for this release on GitHub: https://github.com/Julie-Fabre/bombcell/releases/tag/v1.6.0 |
||
1.5.0 | See release notes for this release on GitHub: https://github.com/Julie-Fabre/bombcell/releases/tag/v1.5.0 |
||
1.4.0.0 | See release notes for this release on GitHub: https://github.com/Julie-Fabre/bombcell/releases/tag/v1.4.0 |
||
1.3.0.0 | See release notes for this release on GitHub: https://github.com/Julie-Fabre/bombcell/releases/tag/v1.3.0 |
||
1.2.0.0 | See release notes for this release on GitHub: https://github.com/Julie-Fabre/bombcell/releases/tag/v1.2.0 |
||
1.1.0.0 | See release notes for this release on GitHub: https://github.com/Julie-Fabre/bombcell/releases/tag/v1.1.0 |
||
1.0.1 |