neurotorchmz

neurotorchmz#

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.

neurotorchmz.start(edition: Edition = Edition.NEUROTORCH, headless: bool = False, background: bool = False) Session#

Create a new session of Neurotorch. You can access it via the provided Session object returned by this function (only in background mode). In contrast to a session, use neurotorchmz.API if you don’t want Neurotorch to manage your data and only want to access the detection functions.

Parameters:
  • edition (Edition) – Choose which edition of Neurotorch you want to launch

  • headless (bool) – When set to true, the tkinter GUI is not opened. Some functions may not work in headless mode

  • background (bool) – Controls wether the GUI is running in a different thread. Note that tkinter may raise warnings, which can generally be ignored.

Returns Session:

A session object to interact with the GUI

neurotorchmz.start_background(edition: Edition = Edition.NEUROTORCH, headless: bool = False) Session#

Create a new session of Neurotorch. You can access it via the provided Session object returned by this function (only in background mode). In contrast to a session, use neurotorchmz.API if you don’t want Neurotorch to manage your data and only want to access the detection functions.

Note: This function is an alias for start(background=True)

Parameters:
  • edition (Edition) – Choose which edition of Neurotorch you want to launch

  • headless (bool) – When set to true, the tkinter GUI is not opened. Some functions may not work in headless mode

  • background (bool) – Controls wether the GUI is running in a different thread. Note that tkinter may raise warnings, which can generally be ignored.

Returns Session:

A session object to interact with the GUI

core

The core module contains the most important parts of Neurotorch.

gui

gui.components

plugins

utils