Skip to main content

Neurotorch is a tool designed to extract regions of synaptic activity in neurons tagges with iGluSnFR, but is in general capable to find any kind of local brightness increase due to synaptic activity

Project description

Python Version from PEP 621 TOML Dynamic TOML Badge Dynamic TOML Badge

Please note: There is another project called neurotorch on GitHub/PyPI not related to this project. To avoid mix-up, the package is named neurotorchmz with the mz as a refrence to Mainz where the software was developed.

Neurotorch

Neurotorch is a tool designed to extract regions of synaptic activity in neurons tagges with iGluSnFR, but is in general capable to find any kind of local brightness increase due to synaptic activity. It works with microscopic image series / videos and is able to open an variety of formats (for details see below)

  • Fiji/ImageJ: Full connectivity provided. Open files in ImageJ and send them to Neurotorch and vice versa.
  • Stimulation extraction: Find the frames where stimulation was applied
  • ROI finding: Auto detect regions with high synaptic activity. Export data directly or send the ROIs back to ImageJ
  • Image analysis: Analyze each frame of the image and get a visual impression where signal of synapse activity was detected
  • API: You can access the core functions of Neurotorch also by importing it as an python module

Installation

You need python to run Neurotorch. Also it is recommended to create a virtual enviorenment to not mess up with your other python packages, for example using miniconda. When inside your virtual enviorenment, simply type

pip install neurotorchmz

Also, you need to install OpenJDK and Apache Maven to run PyImageJ. An easy solution is to use the bundled Build from Microsoft you can find here

To update your installation, type

pip install neurotorchmz --upgrade

Documentation

There is neurotorch_documentation.pdf on the GitHub repository, but you can also access it from inside Neurotorch on the tab 'Welcome to Neurotorch'

About

Neurotorch was developed at the AG Heine (Johannes Gutenberg Universität, Mainz/Germany) and is currently under active development.

Development roadmap

Currently in active development:

  • released Integration of plugins: Rather than providing an direct binding to TraceSelector, it will be implemented as a plugin
  • New ROI finding algorithm based on local maxima

Ideas for future releases:

  • Synapse analysis tab: Same algorithm as in the Synapse ROI finder, but for each signal frame separately

Impressions

Please note: Neurotorch is under continuous development. Therefore the visuals provided here may be outdated in future versions.


First impression of an file opened in Neurotorch. For specific file formats (here nd2), a variety of metadata can be extracted


Use the tab 'Signal' to find the timepoints with stimulation (marked in the plot on the left site with yellow dots). You can also use this tab to view the video frame by frame


Extraction of regions with high synaptic activity. For the choosen image with good enough signal to noise ratio, all settings were determined automatically by the program and nothing more than pressing 'Detect' was necessary to get this screen. The ROIs are marked in the images with red boundaries while the selected ROI displayed also with the mean value over time is marked with yellow boundaries

Release notes

24.12.3 (05.12.2024):

  • Bugfix: Minor bugfix on exporting as CSV

24.12.2 (05.12.2024):

  • Import ROIs from ImageJ: Now you can import ROIs from Fiji/ImageJ
  • Select ROIs by clicking on them: When clicking into the plot of the ROI Finder tab, the nearest ROI will now be selected
  • Added ROI Stage: Now it is possible to keep some or all detected ROIs in the ROI Finder tab on a stage where they won't be cleared on redetecting on loading a new image
  • Custom ROI names: Now ROIs can have custom names. Use the button 'Reset Name' to remove custom names
  • Trace Selector: The filename is now carried over when exporting into TraceSelector
  • Code improvements: Better handling of the Tab ROI Finder Invalidation Events; New Button layout on the same tab
  • Bugfixes: names and PIMS metadata were cleared when opening an image; Fixed some wrong checks for empty ImageObjects; Some crashes on exporting as CSV

24.12.1 (29.11.2024)

  • Sorting by signal strength: Added the ability to sort by signal strength in local max algorithm. Also added the option to filter for a minimum signal strength
  • Circular ROI: Added region props for circular ROIs in local max algorithm. Also changed the definition of a circle with radius r to be equivalent with ImageJ
  • Added image filters: Added the ability for image filters and included as first the option to use img - mean(img) instead of imgDiff for detection
  • Minor changes: Bugfixes (usage of numpy.empty, trace selector filedialog, matplotlib backend setting...) and improvement of speed (for example slicing the image)

24.11.7 (27.11.2024)

  • New API: Better integration of the API
  • Bugfixes: Fixing bug in ImageJ Implementation

24.11.6 (27.11.2024)

  • New detection algorithm: Added the Local Maximum Algorithm with much better performance than
  • GUI: Massively improved the GUI settings by applying a consistent layout
  • Detection Algorithms: Complete rewrite of the detection algorithms integration and adjusting of some parameters
  • New Tooltip feature: Introduced tooltips and a new libary to handle string ressources in Neurotorch
  • Normalized Std, Mean and Median: By default, for ROI detection now normalized values are used
  • Colorbar: Added colorbar to all plots
  • Improved signal removing: Fixed and improved some inconsistencies creating the imgDiff
  • Image Source: Now for all algorithms the image source can be selected (not just Hysteresis Thresholding)
  • Massive code review: Massive review of code and improved stability, for example event system, image loading or Tab ROIFinder plotting

24.11.5 (21.11.2024)

  • Bugfix The documentation was not included properly

24.11.4 (21.11.2024)

  • Introduction of Plugins: Added the ability to add plugins to neurotorch and introduced TraceSelector as preinstalled plugin
  • Cache: Added 'Clear cache' option to denoise menu
  • Various bugfixes

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neurotorchmz-24.12.3.tar.gz (5.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neurotorchmz-24.12.3-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file neurotorchmz-24.12.3.tar.gz.

File metadata

  • Download URL: neurotorchmz-24.12.3.tar.gz
  • Upload date:
  • Size: 5.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for neurotorchmz-24.12.3.tar.gz
Algorithm Hash digest
SHA256 69fe29b258affb0179591c7dbb4de39a79b2286ed16bf2a58467d4e11b7d7ea6
MD5 04c8955646c2a08254dfaaf30b060580
BLAKE2b-256 c8b8e6b206ab1395c316a5ad41ffc01e08c1f0b857a89dfe704dd0e7c107f75f

See more details on using hashes here.

File details

Details for the file neurotorchmz-24.12.3-py3-none-any.whl.

File metadata

  • Download URL: neurotorchmz-24.12.3-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for neurotorchmz-24.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8b1621329ae9c9b56ec86fe5e6addbd6d25438db4067c8cacb177b5a7f1c530f
MD5 cf07fc756ab587b1061add90e757256d
BLAKE2b-256 97e6ea9951108484e6f3c5fed7bb384707ddb59ff1d4e8173b934fa0f7b38969

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page