Skip to main content

A PyQt6-based application for ROI visualization.

Project description

RoiBaView

PyPI version
License: MIT

RoiBaView is an interactive Python tool for plotting, analyzing, and exploring ROI-based signals from experiments like Calcium Imaging and Biomedical Data Acquisition.
Visualize, detect peaks, sync data with videos, and manage your datasets with an intuitive graphical interface.

Try RoiBaView Online (Docs & Demo)
Install from PyPI


Features

  • Import and visualize ROI-based time-series data (from CSV files)
  • Peak detection with adjustable parameters and live preview
  • Video viewer for syncing recorded videos (or TIFF stacks) with data traces
  • CSV file format converter (handle different separators)
  • Built-in video converter powered by ffmpeg
  • Easy-to-use interface for data management and export
  • Designed for experiments like calcium imaging, electrophysiology, and more

Installation

  1. Create a new environment (e.g., using Anaconda):

    conda create -n roibaview
    
  2. Activate the environment and ensure pip is installed:

    conda activate roibaview
    conda install pip
    
  3. Install RoiBaView via PyPI:

    pip install roibaview
    

Importing Data

You can import data from CSV files:

  • Go to File → Import CSV file...
  • Supported structure:
ROI_1 ROI_2 ... ROI_n
x₀ x₀ ... x₀
x₁ x₁ ... x₁
... ... ... ...
  • Specify the sampling rate (Hz) when prompted.
  • If the dataset is global (same trace across ROIs), check the Global Dataset option.

Note: Only CSVs with comma (,) separator are supported.
Need to convert from another separator? Use:
Tools → Convert CSV files


Plotting and Data Analysis

  • After importing, your datasets appear on the left sidebar.
  • Left-click to activate a dataset.
  • Right-click for more options (rename, modify, etc.)

Peak Detection

  • Activate a dataset, then click Detect Peaks.
  • Customize detection parameters and watch live detection updates.
  • Export detected peak information to CSV.

Video Viewer & Video Converter

  • Open the Video Viewer under Tools → Open Video Viewer.
  • Connect video frames to ROI data for synchronized viewing.
  • Video Converter (Tools → Open Video Converter) lets you:
    • Convert between formats using FFmpeg (you must have it installed).

Download FFmpeg from https://ffmpeg.org/.


Documentation & Links


Author

Developed by Nils Brehm (2025)
License: MIT License


Keywords: Python ROI viewer, Calcium Imaging Visualization, Biomedical Signal Viewer, Interactive Data Analysis, Open-Source Visualization

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

roibaview-0.1.9.tar.gz (39.8 kB view details)

Uploaded Source

Built Distribution

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

roibaview-0.1.9-py3-none-any.whl (46.6 kB view details)

Uploaded Python 3

File details

Details for the file roibaview-0.1.9.tar.gz.

File metadata

  • Download URL: roibaview-0.1.9.tar.gz
  • Upload date:
  • Size: 39.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for roibaview-0.1.9.tar.gz
Algorithm Hash digest
SHA256 cc48efeeef4bb0472ba28470e67fb6d59fcb38143b757ffba14494d0b6109414
MD5 408f313ba001b878d1dcb52106f25021
BLAKE2b-256 139ee1443988965f6f7354b9cefcb81c66440ab2579326d172316d2296adbf2a

See more details on using hashes here.

File details

Details for the file roibaview-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: roibaview-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 46.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for roibaview-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 32e9efddd654572b3321b930468cc954e04e8c2713f3b672e3af9491f17e97b7
MD5 373a91f95826a6638e3163c761f46c77
BLAKE2b-256 07ed86fc92db6211e2cb7ec6c7fef5e2df2d348c64dc59f850424e42cff01092

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