toolsandogh

A Python toolbox for iSCAT microscopy data analysis, developed by the Sandoghdar Division of the Max Planck Institute for the Science of Light (MPL).

Overview

toolsandogh provides a small, reusable library for loading, processing, analyzing, and storing microscopy videos. It is designed around a canonical 5D data model---T (time), C (channel), Z (slice), Y (row), X (column)---implemented as lazy xarray arrays backed by Dask.

Features

  • Lazy, out-of-core computation: Videos are kept as Dask arrays so you can work with datasets larger than memory.
  • Labeled, metadata-rich arrays: Results are xarray.DataArray objects with TCZYX dimensions and OME metadata.
  • Multiple microscopy formats: Read and write RAW/BIN, TIFF, OME-TIFF, OME-Zarr, ND2, and other formats supported by bioio.
  • Reusable analysis primitives: Rolling statistics, radial variance transform, synthetic data generation, and more.

Installation

This project uses the uv package manager. Clone the repository and run:

uv sync

To install in editable mode for development:

uv pip install -e ".[dev]"

Quick start

import toolsandogh as sand

# Load a video (any bioio-supported format or raw BIN/RAW file).
video = sand.load_video("movie.nd2")

# Apply a rolling average along the time axis.
smoothed = sand.rolling_average(video, window_size=5, dim="T")

# Save the result back to disk.
sand.store_video(smoothed, "smoothed.ome.tiff")

Use help(sand.load_video) or help(sand.store_video) for details on the available arguments.

Repository layout

  • src/toolsandogh/ --- the main Python package.
  • src/toolsandogh/tests/ --- pytest test suite.
  • DESIGN.md --- design conventions and coding standards.

Contributing

Please see DESIGN.md for coding conventions, documentation standards, and architecture decisions. In brief:

  • All public functions must be type-hinted and documented in numpydoc style.
  • Code is linted with ruff and type-checked with pyright.
  • Prefer free functions; keep data in xarray.DataArray/Dataset form.
  • Tests go in src/toolsandogh/tests/.

License

GPL-3.0-or-later.

Project links

Data verified by PyPI on Jul 16, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.5.4)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for marcoheisig from gravatar.com marcoheisig Avatar for sandoghdarlab from gravatar.com sandoghdarlab

Credits

Author: Marco Heisig

GitHub Statistics

Data verified by PyPI on Jul 16, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

GPL-3.0-or-later
View SPDX License List

Requires

Python >=3.12

Tags

tools utilities python microscopy

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toolsandogh-0.4.0.tar.gz (293.3 kB view details)

Uploaded Source

Built Distribution

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

toolsandogh-0.4.0-py3-none-any.whl (96.8 kB view details)

Uploaded Python 3

File details

Details for the file toolsandogh-0.4.0.tar.gz.

File metadata

  • Download URL: toolsandogh-0.4.0.tar.gz
  • Upload date:
  • Size: 293.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for toolsandogh-0.4.0.tar.gz
Algorithm Hash digest
SHA256 134346a2188f6a345c40026762bf31ed6c1e28cafb46e4d57d00b6388f9a6a0b
MD5 c3a5aa6fa4f687213c9de348f5c0d572
BLAKE2b-256 c6a48a03ce7e22d49b7ad6bbc63cec44fb4fdd23bdf7773bad7295d1a79e8a90

See more details on using hashes here.

Provenance

The following attestation bundles were made for toolsandogh-0.4.0.tar.gz:

Publisher: release.yml on SandoghdarLab/toolsandogh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file toolsandogh-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: toolsandogh-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 96.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for toolsandogh-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3db865f537c2b761dd28ed853b15b414c518af5a8f4b68571a02098486f31350
MD5 80b37904fa4400130e23903f03f81fdc
BLAKE2b-256 5fdbc9d041a0a2fdb42651dcd55f06e683987a3041496cb7f482593aef1eef01

See more details on using hashes here.

Provenance

The following attestation bundles were made for toolsandogh-0.4.0-py3-none-any.whl:

Publisher: release.yml on SandoghdarLab/toolsandogh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

This release

0.4.0 This release

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.2.0

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3.1

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

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