Skip to main content

Interactive and algorithmic tools for matching and curating neurons across calcium imaging sessions

Project description

CATAN

CATAN (Curation and Analysis of Tracked Across-sessions Neurons) is an open-source, cross-platform toolbox for the analysis, tracking and curation of neuronal populations in longitudinal calcium imaging experiments.

It provides an interactive GUI together with a Python API for

  • visualization of calcium imaging sessions
  • ROI inspection
  • registration and remapping between sessions
  • probabilistic neuron matching
  • quality assessment
  • export/import of tracking results

CATAN is primarily designed for CaImAn output but aims to remain extensible.


Features

  • Interactive Qt/VisPy GUI
  • Fast visualization of thousands of ROIs
  • Across-session neuron tracking
  • Rigid and non-rigid remapping
  • Sparse matrix support
  • HDF5-based project format
  • Scriptable Python API

Installation

pip install catan-toolbox[gui]

or

git clone https://github.com/goecidbn/CATAN_toolbox.git
cd CATAN
pip install -e ".[gui]"

CATAN allows for a GUI-less setup, not requiring graphic libraries such as PySide6 and vispy. For most users, the installation including the GUI will be of interest and can be set up via the commands above. For a graphic-less setup, use

pip install catan-toolbox

Running CATAN

catan

or

from catan.gui.app import main

main()

Development

git clone https://github.com/goecidbn/CATAN_toolbox.git
pip install -e ".[gui,dev]"

Run the tests

pytest

Project status

CATAN is currently under active development. The file format and Python API may change until the first stable release.


Citation

If you use CATAN in scientific work, please cite

(paper / DOI once available)


License

MIT License

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

catan_toolbox-0.1.1.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

catan_toolbox-0.1.1-py3-none-any.whl (193.5 kB view details)

Uploaded Python 3

File details

Details for the file catan_toolbox-0.1.1.tar.gz.

File metadata

  • Download URL: catan_toolbox-0.1.1.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for catan_toolbox-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7422b12b4ccc1aebc95bfc5e84b0b385253356c97be618f5571bb93d7518fb05
MD5 59cd98b330c549c6ef690637d437fb3d
BLAKE2b-256 6e12166edd9619e6fe2654d2f103576c7fa1546d0c3ad4fef64a5614ec434b3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for catan_toolbox-0.1.1.tar.gz:

Publisher: release.yml on goecidbn/CATAN_toolbox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file catan_toolbox-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: catan_toolbox-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 193.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for catan_toolbox-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c9dfb2398f089909ac6f8cb6fe8d9df76e6109137723d40155b8b51237a4dc0
MD5 cb1258cf36d7ea74a01d0ea6f43ad0cb
BLAKE2b-256 70f642a88afc98102a8b6929914e94f6824a3b0916529550b6af6df4c721ad0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for catan_toolbox-0.1.1-py3-none-any.whl:

Publisher: release.yml on goecidbn/CATAN_toolbox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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