Package: mesmerize
PyPIDownloadsLicenseMaintenanceDocumentationCode analysisChat & HelpIssue trackerMesmerize is a platform for the annotation and analysis of neuronal calcium imaging data. Mesmerize encompasses the entire process of calcium imaging analysis from raw data to interactive visualizations. Mesmerize allows you to create FAIR-functionally linked datasets that are easy to share. The analysis tools are applicable for a broad range of biological experiments and come with GUI interfaces that can be used without requiring a programming background.Associated bioRxiv paper:https://doi.org/10.1101/840488Video Tutorials!We have recently created detailed video tutorials! The main tutorial series provides a quick overview that takes you from raw imaging data, to downstream analysis and interactive visualizations:https://www.youtube.com/playlist?list=PLgofWiw2s4REPxH8bx8wZo_6ca435OKqgAdditional videos on specific aspects of Mesmerize will be posted here:https://www.youtube.com/playlist?list=PLgofWiw2s4RF_RkGRUfflcj5k5KUTG3o_More tutorial videos will be available soon.InstallationIf you're familiar with anaconda or virtual environments, installation is as simple as:pip install mesmerizeAfter installation just callmesmerizefrom inside the virtual environment to launch it.If you're unfamiliar with virtual environments, see the docs for more detailed instructions on all operating systems:http://docs.mesmerizelab.org/en/master/user_guides/installation.htmlCaimanIn order to useCaImAnfeatures you will need to haveCaImAninstalled into your environment. See the Mesmerize installation instructions linked above for more details:http://docs.mesmerizelab.org/en/master/user_guides/installation.htmlCaiman is used for the following Viewer modules: CNMF, 3D CNMF, CNMFE, caiman motion correction and Detrend DFOF.tslearnIn order to use tslearn features you will needtslearn. This can be installed via pip or conda, see the detailed installation instructions for more details:http://docs.mesmerizelab.org/en/master/user_guides/installation.htmltslearn is used for KShape clustering, cross-correlation analysis, and some of the flowchart nodes.tensorflowIn order to use nuset segmentation you will needtensorflow v1.15. You can use eithertensorflow(CPU bound) ortensorflow-gpupip install --upgrade pip setuptools
pip install tensorflow~=1.15DocumentationDocumentation is available here:http://docs.mesmerizelab.org/Questions/DiscussionsFeel free to ask questions or discuss things on gitter. For larger bugs/issues please use the issue tracker.Issue tracker:https://github.com/kushalkolar/MESmerize/issuesNewsSee thechangelogfor more detailsNovember 2020Changes:Bokeh based plots that use a bokeh-based datapoint tracer, still in very early stagesk-Shape "gridsearch", select a n-partitions range and number of combinations, returns heatmap of all k-Shape runs with inertia values NOTE: The gridsearch is not saved when the plot is saved. Only the chosen kshape iteration will be saved. This will be fixed in a future releasePlot neural dynamics in PCA or LDA spacePadArrays flowchart node to pad dataframe arrays when sizes don't match, useful when splicing is undesiredView mean, max, or std projection of caiman motion correction outputs by selecting them from the batch managerSeptember 2020Version 0.3 releasedChanges:Cross correlation plots with stimulus maps.Support for Femtonics .mes and .mesc recordings.Segmentation using deep learning via NuSeT.July 2020Changes:Mesmerize can now be installed via pip.Much easier to import imaging meta data from other sources.Create stimulus tuning curve plots.ΔF/F must now be extracted at the Viewer stage for caiman data, or set through other methods. Spikes and ΔF/F can be visualized in the Viewer.June 2020Version 0.2 released.Changes:Windows is now supported!The Viewer can handle 3D data and 3D ROIs.For development, classes are provided for creating Volumetic ROI types, and a Volumetic ROI manager.Caiman 3D CNMF is supported.Updated CNMF(E) and motion correction modules to use the latest release of CaImAn. Parameter entry GUIs are much more flexible now.CNMF(E) data can be imported directly from hdf5 files from Caiman. Therefore you can use your own scripts/notebooks and existing CNMF hdf5 files for downstream analysis in Mesmerize.More customizable support for use of caiman modules within the Mesmerize viewer's script editor.Suite2p importer added, allowing you to perform downstream analysis of Suite2p output data in Mesmerize.Some cleanup with the batch managerbug fixesPlease note that batches from v0.1 and v0.2 are not inter-compatible. Use the v0.1 branch if you need v0.1Nov 2019:See our recent biorxiv manuscript where we use Mesmerize to analyze a calcium imaging dataset fromCiona intestinalisas well as other model organisms!https://doi.org/10.1101/840488UpcomingExperimental use of the bioformats importer for the Viewer.Export lite versions of projects for easier sharing.Browsers based visualizations for sharing analysis results.Acknowledgementspyqtgraphdevelopers for creating such an expansive library, which we built upon to create many of the interactive elements of Mesmerize.CaImAndevelopers have created a very robust library for pre-processing and signal extraction of calcium imaging data, which Mesmerize is able to interface with.Simon Daste provided sample data and assistance which allowed for creation of the Suite2p importer module.Jordi Zwiggelaarcreated the Mesmerize logo & banner.