Skip to main content

Treatment pipeline for suite2p extracted fluorescent traces over time.

Project description

Treat2p

Made to be used with suite2p, to extend it's capabilities with treatment ones, on top of the nice roi signal extraction features of suite2p.

Made after the matlab developments of Pierre Pierre Marie Gardères

Getting started

To install this package, you simply need to hop into your own virtual environment and run :

pip install treat2p

or

uv add treat2p

How to use :

In short, to treat some plane/channel data that suite2p extracted already:

import treat2p
suite2p_path = r"C:\Users\yourname\Desktop\suite2p"
outputs, stats, ops = treat2p.run_treat2p(suite2p_path, plane = 0, chan = 1)

run_treat2p takes all the arguments that goes into the various stages of the pipeline, registers, them, and stores them in the ops.npy file under the treat2p key.

The stages of treat2p pipeline are (for each roi):

  • neuropil factor estimation (and correction)
  • slow trend estimation (and correction)
  • deltaF/F0 normalization
  • "mean centered" normalization

For a bit more explanations, please see the jupyter notebook tutorial here.

Getting started

Made to be used with suite2p, to extend it's capabilities with treatment ones, on top of the nice roi signal extraction features of suite2p.

Made following the matlab developments of Pierre Marie Gardères

Installation

To install this package, you simply need to hop into your own virtual environment and run :

=== "pip" .sh pip install treat2p === "uv" .sh uv add treat2p

How to use

In short, to treat some plane/channel data that suite2p extracted already:

import treat2p
suite2p_path = r"C:\Users\yourname\Desktop\suite2p"
outputs, stats, ops = treat2p.run_treat2p(suite2p_path, plane = 0, chan = 1)

run_treat2p Takes all the arguments that goes into the various stages of the pipeline, registers, them, and stores them in the ops.npy file under the treat2p key.

The stages of treat2p pipeline are (for each roi):

For a bit more explanations, please see the jupyter notebook tutorial here.

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

treat2p-0.1.8.tar.gz (500.9 kB view details)

Uploaded Source

Built Distribution

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

treat2p-0.1.8-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file treat2p-0.1.8.tar.gz.

File metadata

  • Download URL: treat2p-0.1.8.tar.gz
  • Upload date:
  • Size: 500.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for treat2p-0.1.8.tar.gz
Algorithm Hash digest
SHA256 de6cfc648ca55de2448d35e9a3f1b016862f8d238515ec314f5aa17758a69fbb
MD5 268e17cad7c68ca96d8fcab37ae19dd6
BLAKE2b-256 4cef4104d5742086807fab3270cb345e6ad58e44b1a43e1d6984056ba6b4238a

See more details on using hashes here.

File details

Details for the file treat2p-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: treat2p-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for treat2p-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 270aeb31f7a5b9792202fd78b76bcb888ee42e4d723044a457bde8b469b49d7e
MD5 a02d12cdcc9e778f45e25f5db633ada1
BLAKE2b-256 fde0a2fde3e1bef72c20707a9a2b84c0a6c3b7ab695a0452fba598339e1f7339

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