Skip to main content

A PyQt6 GUI toolbox for processing two-photon phasor imaging data

Project description

Phasor-Handler (Windows)

Phasor Handler is a toolbox for processing raw two-photon phasor imaging data: convert → register → explore → extract calcium traces.
It provides a PyQt6 GUI for viewing registered or raw stacks (Ch1/Ch2), z-projections (std/max/mean), drawing/storing ROIs, overlaying stimulated ROIs from metadata, and exporting ROI traces.

⚠️ Platform: Windows 10/11 only
🧪 Status: actively developed (Brightness & Contrast dialog is WIP)


Features

  • Load registered TIFF (Ch1-reg.tif, Ch2-reg.tif) or raw NPY fallbacks (ImageData_Ch0_TP0000000.npy, ImageData_Ch1_TP0000000.npy)
  • Linear and non-linear motion-correct TIFF images using Suite2p
  • Automated cell detection using Suite2p
  • Channel switching (Ch1/Ch2) and Composite (G/R)
  • Z-projections: standard deviation, max, mean
  • ROI tools: draw elliptical ROIs, translate or rotate ROIs, save/load as JSON, quick-select saved ROIs
  • Stimulus overlay: show stimulated ROI locations from experiment metadata and add to the saved ROIs
  • Trace plotting: configurable formula, custom y-limits, frame/time (s) x-axis
  • Export: write per-ROI traces for all frames to .txt (tab-separated)
  • Keyboard: R save/add ROI, Delete remove selected ROI, Esc clear selection, Alt+S load stimulated ROIs, Right Click + drag translate selected ROI, Y toggle right click to rotation mode

Input data layout

For each dataset directory, Phasor Handler looks for any of:

  • Ch1-reg.tif
  • Ch2-reg.tif # optional
  • ImageData_Ch0_TP0000000.npy # raw fallback for Ch1
  • ImageData_Ch1_TP0000000.npy # optional raw fallback for Ch2
  • experiment_summary.pkl # optional metadata (or .json)

Registered TIFFs are preferred when available; raw NPYs are used as fallback.


Installation (Windows, Conda)

This project provides an environment.yml for Windows. The environment is large (GUI, image I/O, napari/suite2p), so mamba is recommended, but conda works too.

1) Install Conda/Mamba (if needed)

  • Install Miniconda or Mambaforge on Windows.
  • (Optional) Add mamba for faster solves:
    conda install -n base -c conda-forge mamba
    

2) Get the code

  • Clone the repo and change it into
    git clone https://github.com/joshemuel/Phasor-Handler.git
    chdir Phasor-Handler
    
  • Alternatively, you can download the entire project as a zip file, unzip it, then open that directory in Miniconda cd Phasor-Handler

3) Create the environment

  • Using mamba:
    mamba env create -f environment.yml
    
  • Using conda:
    conda env create -f environment.yml
    

4) Activate and run

  • Before running the toolbox, activate the environment
    conda activate suite2p
    python app.py
    

Update (Windows, Conda)

1) Go to your local repo and pull the latest code from the branch you use

chdir Phasor-Handler
git pull --ff-only

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

phasor_handler-2.2.3.tar.gz (97.2 kB view details)

Uploaded Source

Built Distribution

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

phasor_handler-2.2.3-py3-none-any.whl (101.4 kB view details)

Uploaded Python 3

File details

Details for the file phasor_handler-2.2.3.tar.gz.

File metadata

  • Download URL: phasor_handler-2.2.3.tar.gz
  • Upload date:
  • Size: 97.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for phasor_handler-2.2.3.tar.gz
Algorithm Hash digest
SHA256 fc018f9c715db8b8f99d0f15cb8362cecd0a151c2bd7da39f2e0963587e29cc5
MD5 0a926225454f402768e000a94c447c20
BLAKE2b-256 17a08aa2ad3a9c50f325a65c5a3e0f49551806caa23996ab506333bc8c0f2586

See more details on using hashes here.

File details

Details for the file phasor_handler-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: phasor_handler-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 101.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for phasor_handler-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0837a42cf04f27eed27498c749d576ed28710adbb91e3e6495c7ee41df637c8c
MD5 39a8fc6ff373ef8f47d33dbe7d78aed8
BLAKE2b-256 7f5997ebd637066db5e9a2551c480515e9fa56d50dcdebc6c6110510260bebe9

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