A Python-based GUI tool for cellular event detection from .avi and .tiff files.
Project description
BioImageSuiteLite
An Interactive Open-Source Platform for Automated Detection and Analysis of Transient Events in Time-Lapse Microscopy
A screenshot of the main BioImageSuiteLite interface.
Overview
BioImageSuiteLite is a user-friendly desktop application designed for biologists and researchers to analyze time-lapse microscopy data. It simplifies the entire workflow from data import to results export, enabling rapid, reproducible analysis of cellular events.
The tool provides an intuitive graphical user interface (GUI) built on the powerful Napari viewer, allowing users to perform end-to-end analysis of cellular events.
Key Features
- Versatile Data Import: Load time-lapse microscopy data from both
.avivideo files and multi-page.tif/.tiffimage stacks. - Interactive ROI Drawing: Easily draw, manage, and analyze multiple Regions of Interest (ROIs) on your data using Napari's intuitive tools.
- Advanced Event Detection: Utilize multiple algorithms for event detection, including:
- Threshold-based: Simple and effective for clear signals.
- Difference of Gaussians (DoG): Robustly detects blob-like features and transient intensity peaks.
- Scisson-like (Step Detection): (In development) For analyzing step-like changes in intensity.
- Automated Analysis & Export: Automatically calculate normalized event rates (events/sec/µm²) and export detailed event data and ROI coordinates to CSV for further analysis.
- Integrated Plotting: Instantly visualize analysis results with built-in plotting for event rates and intensity traces.
Installation
We recommend installing BioImageSuiteLite into a dedicated Python virtual environment.
# First, create and activate a virtual environment
python -m venv venv
source venv/bin/activate # On Windows, use: venv\Scripts\activate
# Now, install the package from PyPI
pip install bioimagesuitelite
For the latest development version, you can also install directly from GitHub:
pip install git+https://github.com/InnovationLine/BioImageSuiteLite.git
Quick Start
-
Launch the application: Open your terminal or command prompt (with the virtual environment activated) and run:
bioimagesuitelite
-
Load Data: Click the "Load File" button to open your microscopy data (
.avior.tif/.tiff). -
Draw an ROI:
Select your preferred ROI drawing mode (Rectangle, Ellipse, Polygon, or Freehand Path) from the dropdown menu in the "Preprocessing & ROI" section, then draw one or more regions around the cells you want to analyze. The interface now provides helpful tooltips for all controls. -
Run Analysis: Adjust parameters in the GUI dock widget as needed (e.g., Gaussian sigma, thresholding method). Click the "Run Analysis" button to start processing.
-
Explore Results: View the generated plots for event traces and intensity profiles. Use the "Save Data" button to export your quantitative results to a CSV file.
For a detailed reference, see the full User Guide.
System Requirements
- Python >= 3.8
- The core dependencies are listed in the
pyproject.tomlfile and include:numpyscipyopencv-python-headlesstifffilescikit-imagenapari[all]shapelyruptures
How to Cite
If you use BioImageSuiteLite in your research, please cite it using the metadata below.
Tutorial: An Interactive Guide
For a hands-on tutorial that walks you through a complete analysis workflow—from loading data to exporting results—please see our comprehensive Jupyter Notebook. This is the best place to start to understand the full capabilities of BioImageSuiteLite.
For Developers
We welcome contributions! To set up a development environment:
Setting up the Environment
# Clone the repository
git clone https://github.com/InnovationLine/BioImageSuiteLite.git
cd BioImageSuiteLite
# Create a virtual environment
python -m venv venv
source venv/bin/activate
# Install in editable mode with developer dependencies
pip install -e .
Running the GUI from source
To launch the GUI directly from the source code, run:
python -m BioImageSuiteLite.gui_manager
For more details on the project structure and architecture, please see our Architecture Guide.
License
This project is licensed under the MIT License. See the LICENSE file for details. This license permits free use, modification, and distribution of the software, provided the original copyright and license notice are included in any copies.
Citation
BioImageSuiteLite is academic software. If you use it in your research, please cite it as follows:
Dasgupta, Rinki, & Das, Kaushik. (2025). BioImageSuiteLite (Version 0.1.4) [Software]. Zenodo. https://doi.org/10.5281/zenodo.16789347
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bioimagesuitelite-0.1.4.tar.gz.
File metadata
- Download URL: bioimagesuitelite-0.1.4.tar.gz
- Upload date:
- Size: 28.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa00438e2ef6833f69e62572e55b8c88041e0f48452654bbca740a7754e9f79b
|
|
| MD5 |
8e36263722a36c291742c7c338ca69f4
|
|
| BLAKE2b-256 |
9ac159c1306bb59300a19a1c7c489adfbf2f34c404fd433b5ae864c405de423b
|
File details
Details for the file bioimagesuitelite-0.1.4-py3-none-any.whl.
File metadata
- Download URL: bioimagesuitelite-0.1.4-py3-none-any.whl
- Upload date:
- Size: 29.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ef324adc162a1fc77b183933d86501902193455f2e861736ba61e5ba6a62bd6a
|
|
| MD5 |
9b300533783693ccbcdde8f8225eac63
|
|
| BLAKE2b-256 |
49c1aac483c054ab364e8cbc1b225d5001939d919b844f0f076c036d8428c9b0
|