Python package for processing large-scale microscopy datasets generated by Arcadia's imaging suite
Project description
arcadia-microscopy-tools
This repository contains a Python package called arcadia_microscopy_tools. The purpose of this Python package is for facilitating analysis of large-scale microscopy datasets generated by Arcadia's imaging suite which includes several microscopes:
- Nikon ECLIPSE Ti2-E (Hina)
- Nikon ECLIPSE Ni-E (Babu Frik)
- Leica Stellaris 8 (The Borg)
This package provides tooling for image preprocessing, cell/particle segmentation, morphology analysis, fluorescence quantification, and batch processing pipelines. Supports native ND2 file format via nd2. LIF file support is in progress and will use liffile. The package integrates with popular scientific Python libraries for streamlined high-content screening and quantitative microscopy workflows.
Installation
Basic installation
Install the core package with essential dependencies:
pip install arcadia-microscopy-tools
Optional dependencies
Install with optional features using extras:
[segmentation]- Cellpose for cell/particle segmentation[compute]- Modal for cloud-based processing[all]- All optional dependencies
# Example: install with segmentation support
pip install "arcadia-microscopy-tools[segmentation]"
# Or install all optional dependencies
pip install "arcadia-microscopy-tools[all]"
Usage
Loading microscopy images
Load ND2 files from Nikon microscopes:
from pathlib import Path
from arcadia_microscopy_tools.microscopy import MicroscopyImage
# Load a Nikon ND2 file
example_nd2_path = Path("src/arcadia_microscopy_tools/tests/data/example-multichannel.nd2")
image = MicroscopyImage.from_nd2_path(example_nd2_path)
# Access basic properties
image.shape # Array shape: (4, 256, 256)
image.sizes # Dimension mapping: {'C': 4, 'Y': 256, 'X': 256}
image.channels # List of Channel objects: [Channel(name='BRIGHTFIELD', ...), ...]
image.num_channels # Number of channels: 4
Load LIF files from Leica microscopes:
# Load a Leica LIF file
image = MicroscopyImage.from_lif_path(Path("path/to/image.lif"))
Working with channels
Extract intensity data for specific channels:
from arcadia_microscopy_tools.channels import DAPI
# Get intensity data for a specific channel
dapi_intensities = image.get_intensities_from_channel(DAPI)
# The returned array preserves temporal/spatial dimensions
dapi_intensities.shape # (256, 256)
For more examples, see the docs/examples directory.
Contributing
See how we recognize feedback and contributions to our code.
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
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 arcadia_microscopy_tools-0.2.5.tar.gz.
File metadata
- Download URL: arcadia_microscopy_tools-0.2.5.tar.gz
- Upload date:
- Size: 3.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4960600599ed4313c311c9e208edebcc99ecf6670d16285a109e822798a855af
|
|
| MD5 |
a8843171c07e2ee189fa188c54916a9b
|
|
| BLAKE2b-256 |
0e3e7c26b9953432abaae01dfc2169ba69668ef01cd2fec70d4328e6fdd6b6eb
|
File details
Details for the file arcadia_microscopy_tools-0.2.5-py3-none-any.whl.
File metadata
- Download URL: arcadia_microscopy_tools-0.2.5-py3-none-any.whl
- Upload date:
- Size: 1.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
993e48ab5059850ac41d83f1f9e5988a79eccee20cf1969bf6a2cfa8fa355e28
|
|
| MD5 |
cc63e528341d33ad2357c3d61365291e
|
|
| BLAKE2b-256 |
94b02bad1255be671899596fd13f96d4182e4193c469392f81bab69c75ec181a
|