ConfUSIus 
ConfUSIus is a Python package and napari plugin for handling, visualization, preprocessing, and statistical analysis of functional ultrasound imaging (fUSI) data.
Features
- I/O Operations: Load and save fUSI data in various formats (AUTC, EchoFrame, Iconeus, NIfTI, Zarr), with automatic fUSI-BIDS sidecars for NIfTI.
- Beamformed IQ Processing: Process raw beamformed IQ signals into power Doppler, velocity, and other derived metrics.
- Quality Control: Compute quality metrics (DVARS, tSNR, CV) to assess data quality
- Registration: Motion correction and spatial alignment tools.
- Brain Atlas Integration: Map fUSI data to standard brain atlases for region-based analysis.
- Signal Extraction: Extract signals from regions of interest using spatial masks.
- Signal Processing: Denoising, filtering, detrending, and confound regression.
- Visualization: Rich plotting utilities for fUSI data exploration.
- Napari Plugin: Interactive data loading, live signals inspection, and quality control directly in the napari viewer—no scripting required.
- Xarray Integration: Seamless integration with Xarray for labeled multi-dimensional arrays.
Installation
1. Setup a virtual environment
We recommend that you install ConfUSIus in a virtual environment to avoid dependency conflicts with other Python packages. Using uv, you may create a new project folder with a virtual environment as follows:
uv init new_project
If you already have a project folder, you may create a virtual environment as follows:
uv venv
2. Install ConfUSIus
ConfUSIus is available on PyPI. Install it using:
uv add confusius
Or with pip:
pip install confusius
To install the latest development version from GitHub:
uv add git+https://github.com/confusius-tools/confusius.git
3. Check installation
Check that ConfUSIus is correctly installed by opening a Python interpreter and importing the package:
import confusius
If no error is raised, you have installed ConfUSIus correctly.
Quick Start
import confusius as cf
# Load fUSI data
data = cf.load("path/to/data.nii.gz")
# Perform motion correction
corrected_data = data.fusi.register.volumewise()
# Visualize with napari
corrected_data.fusi.plot()
See the documentation for more detailed usage examples and tutorials.
Citing ConfUSIus
If you use ConfUSIus in your research, please cite it using the following reference:
Le Meur-Diebolt, S., & Cybis Pereira, F. (2026). ConfUSIus (v0.8.0). Zenodo. https://doi.org/10.5281/zenodo.18611124
Or in BibTeX format:
@software{confusius,
author = {Le Meur-Diebolt, Samuel and Cybis Pereira, Felipe},
title = {ConfUSIus},
year = {2026},
publisher = {Zenodo},
version = {v0.8.0},
doi = {10.5281/zenodo.18611124},
url = {https://doi.org/10.5281/zenodo.18611124}
}
Metadata
Release files for confusius 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| confusius-0.8.0.tar.gz | 587.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| confusius-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.3 MB
Release files / confusius-0.8.0.tar.gz
| Download URL | confusius-0.8.0.tar.gz |
|---|---|
| Size | 587.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4ef0b2eafc8771c1068e7d8087940f66a0600f23838dafdbd441d70f02249cd9
|
|
BLAKE2b-256 checksum How to use checksums |
5b41a20963178ec50f5d37e576023bca30285212cc49189c43eb6e7f27adda23
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / confusius-0.8.0-py3-none-any.whl
| Download URL | confusius-0.8.0-py3-none-any.whl |
|---|---|
| Size | 696.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d498202fdcbb164ec668c49f0675bcb0f44b6d4bb008ac8f1bf4627365bdeedc
|
|
BLAKE2b-256 checksum How to use checksums |
c9bdb37377a8f7714486def212d0dcaec4c48927e510c6bd522c9ff233c33f04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|