Skip to main content

PyPI version Full Tests Auto-release codecov documentation License DOI

ROIExtractors

Automatically read optical imaging/segmentation data into a common API

Explore our documentation »

Table of Contents

About

ROIExtractors provides a common API for various optical imaging and segmentation formats to streamline conversion and data analysis. ROI stands for Region Of Interest, which is the region in a set of acquired fluorescence images which the segmentation software has determined as a neuron.

Features:

  • Reads data from 10+ popular optical imaging and segmentation data formats into a common API.
  • Extracts relevant metadata from each format.

Installation

To install the latest stable release of roiextractors though PyPI, type:

pip install roiextractors

For more flexibility we recommend installing the latest version directly from GitHub. The following commands create an environment with all the required dependencies and the latest updates:

git clone https://github.com/catalystneuro/roiextractors
cd roiextractors
conda env create roiextractors_env
conda activate roiextractors_env
pip install -e .

Note that this will install the package in editable mode.

Finally, if you prefer to avoid conda altogether, the following commands provide a clean installation within the current environment:

pip install git+https://github.com/catalystneuro/roiextractors.git@main

Documentation

See our ReadTheDocs page for full documentation, including a gallery of all supported formats.

Funding

ROIExtractors is funded by

  • Stanford University as part of the Ripple U19 project (U19NS104590).
  • LBNL as part of the NWB U24 (U24NS120057).

License

ROIExtractors is distributed under the BSD3 License. See LICENSE for more information.

Metadata

Release files for roiextractors 0.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for roiextractors 0.11.0
File Size Uploaded Provenance Actions
roiextractors-0.11.0.tar.gz 148.8 kB Without provenance Details for roiextractors-0.11.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for roiextractors 0.11.0
File Interpreter ABI Platform Actions
roiextractors-0.11.0-py3-none-any.whl Python 3 none any Details for roiextractors-0.11.0-py3-none-any.whl

Total release size: 327.3 kB

Release files / roiextractors-0.11.0.tar.gz

Download URL roiextractors-0.11.0.tar.gz
Size 148.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ba81ed9fc056352a59dea644582a85765147e3526d5cd0b26ec32aed22d6f9dc
BLAKE2b-256 checksum
How to use checksums
559c317d5df4d55373dee0f75dbd0cc905b3695079eaef0dd1c7180708cb5709
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / roiextractors-0.11.0-py3-none-any.whl

Download URL roiextractors-0.11.0-py3-none-any.whl
Size 178.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9fe3083336085e76a0ea24ca862f6ae0b4e5e77c059d2a944c6a5b9c8e5b0e65
BLAKE2b-256 checksum
How to use checksums
866107e6acd03bf894ac232ae0ce4e1df852317aa5ea60679e62726b864e3530
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for roiextractors 0.11.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.11.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page