Skip to main content

A napari plugin for analyzing optical coherence tomography (OCT) from biofilm growing on substratum.

Project description

BioOCT

BioOCT is a napari plugin for quantitative analysis of 3D optical coherence tomography (OCT) images, built around the Thorlabs .oct file format. It is suited for biofilm and some scaling variants.

It bundles a domain-specific set of processing functions, interactive widgets, and a reproducible batch-processing pipeline into a toolbox — designed for OCT/biofilm researchers without requiring programming expertise.

The main use cases are:

  • segmenting biofilm or scaling from surrounding fixtures (substratum, optical window, feed spacer, bulk medium) in OCT image stacks with a (near-)planar substratum geometry
  • recording an image processing pipeline once on a representative image, then reproducibly replaying it on a single image or across a full folder/timeseries of .oct files
  • exporting raw and segmented data with preserved voxel geometry and physical spacing, suitable as training data for volumetric ML segmentation models

Features

  • Dedicated reader for Thorlabs .oct files
  • Filtering (Median, Gaussian, Sobel) and contrast enhancement (gamma, percentile clipping, CLAHE)
  • Substratum/window detection with gap interpolation, ROI selection, and reflection/area-masking tools
  • Thresholding via multiple standard algorithms (Otsu, Yen, Li, Mean, Isodata, Triangle, or manual value) with live preview
  • Post-processing (small-object removal) and quantitative evaluation: height maps, biovolume maps, and growth/roughness/porosity metrics export
  • Export to TIFF and NIfTI with voxel spacing and affine metadata preserved
  • Pipeline Manager: records processing steps as human-readable YAML, with single-layer and batch-folder replay for reproducible analysis

Getting Started

Sample Data & Example Pipelines

Three example datasets covering structurally distinct image classes are available via

File > Open Sample > BioOCT

directly in napari, or on Zenodo (DOI: doi.org/10.5281/zenodo.20758173):

  • Membrane with Spacer: membrane substratum with embedded feed spacer fixtures
  • Rough Electrode: electrode substratum with rough surface topology
  • Smooth Electrode with Shadowing: planar electrode substratum with signal shadowing caused by thick biofilm growth

Matching pipeline YAML files for each image class are also available in the above Zenodo dataset, or via the repository in docs/examples/, demonstrating a complete processing workflow from raw .oct to segmentation and metrics export. Load them via the Pipeline Manager widget (LoadReplay Single).


License

MIT License - see LICENSE for details.

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

bio_oct-0.4.tar.gz (360.2 kB view details)

Uploaded Source

Built Distribution

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

bio_oct-0.4-py3-none-any.whl (33.3 kB view details)

Uploaded Python 3

File details

Details for the file bio_oct-0.4.tar.gz.

File metadata

  • Download URL: bio_oct-0.4.tar.gz
  • Upload date:
  • Size: 360.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for bio_oct-0.4.tar.gz
Algorithm Hash digest
SHA256 a6cd8c11cb4bd80c8bd9820592e92a81c08b94aec684a47cd1e05c720ab89968
MD5 b693a9905f9e07ce319cf569661e41e1
BLAKE2b-256 47afe00c9a2990c8724565295acf0cfb1e8ed52f90dca4960cd20660cc1501bc

See more details on using hashes here.

File details

Details for the file bio_oct-0.4-py3-none-any.whl.

File metadata

  • Download URL: bio_oct-0.4-py3-none-any.whl
  • Upload date:
  • Size: 33.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for bio_oct-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 91a91a8c1f9fcc4361e5cc12e1512685ae48a0fcbe19b69deab3602ea302dbc8
MD5 37fd97d93235907f84d9d6c926d3ae1e
BLAKE2b-256 7a24363937628a33073fd1733e854868f4c389f3b37fe2e17b9b6584adc44394

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page