Skip to main content

Calcium imaging automatic ROI selection and analysis tool

Project description

MiV-Ca2 Intensity Analysis Toolbox

A CLI tool for calcium imaging video post-processing: bleaching analysis, ROI selection, and trace extraction.

The package is developed to provide light-weight and easy-to-use tools for calcium imaging video analysis. Data can be saved in csv format for further analysis. (Please note in issue if you have desired format other than csv).

MiV-Ca2 Intensity Analysis Toolbox

Easy installation

pip install ca2roi

Recommend python3.10+.

Easy launch

ca2roi-gui

CLI usage (for batch processing)

ca2roi <video_path> [--workspace <output_folder>]
  • video_path: Path to the calcium imaging video (e.g., AVI file)
  • --workspace: Output directory (default: result)

The tool will:

  • Compute and save bleaching info
  • Compute and overlay fluctuation map
  • Allow interactive ROI selection (or load existing ROIs)
  • Save ROI traces, ROI images, and ROI locations

Python-package ca2roi

import ca2roi

Project Structure

Project uses Python3 as a main backend language. It uses FastAPI to connect frontend and backend. Frontend is developed with Vue3 and TypeScript.

The tool is not yet supported to be launched in a server.

All the core source code is in src folder.

  • ca2roi: Python package for analysis functions.
  • frontend: Vue3 frontend for GUI development
  • commands: CLI command scripts, written with Python with click.

Contribution / Development

Makefile includes useful commands for development.

Support

This project is mainly developed by @skim0119 as part of the support for Mind-in-vitro project.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

ca2roi-0.1.2-py3-none-any.whl (116.5 kB view details)

Uploaded Python 3

File details

Details for the file ca2roi-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ca2roi-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 116.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for ca2roi-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0efb099922d1ecb4d0a4cb63082c6c4e0671f8899d27d8ec33ca94db0f6123d6
MD5 db625b38d6d4973e1a718eb698724cd3
BLAKE2b-256 15c8e70dba4dda8aea70ce45440c7eee18e7d714b340194f5de4893be2d9b0fc

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