cp-anywhere#
CellProfiler-compatible cell profiling in Python and the browser, powered by Rust. Correct illumination, segment images, measure cell features, and export analysis-ready tables.
cp-anywhere turns microscopy images into per-cell feature tables without requiring the CellProfiler desktop application. Use image files or NumPy arrays in Python, work with pandas tables, or run the shared measurement engine in a browser through WebAssembly. See the compatibility guide for supported modules and settings.
Usage#
To run from this repository, install Rust and uv, then run uv sync --frozen.
Run the Python examples with uv run python or in the repository’s virtual environment.
For a hands-on tour, read
Cell Profiling Anywhere
or open the source notebook.
The notebook follows a complete Python workflow: illumination correction,
segmentation, measurements, plots, and image/table exports.
Run uv sync --frozen --group docs first, then select the repository’s .venv
Python interpreter in your notebook editor.
The simplest way to call cp-anywhere is measure_files, which accepts
TIFF/OME-TIFF, PNG, or saved NumPy array file paths directly (or
already-loaded arrays) and returns a tidy pandas.DataFrame:
import cp_anywhere
frame = cp_anywhere.measure_files(
images={"DNA": "dna.tif", "Actin": "actin.tif"},
objects={"Cells": "cells.tif", "Nuclei": "nuclei.tif"},
)
A single image/object-set pair can skip the dict form entirely:
frame = cp_anywhere.measure_files("dna.tif", "cells.tif")
The same file formats work from the command line:
uv run cp-anywhere \
--image DNA=dna.tif --image Actin=actin.tif \
--objects Cells=cells.tif --objects Nuclei=nuclei.tif \
--output result.json
--output also accepts .csv or .arrow (Arrow IPC/Feather, covering
every feature value as one long-form table, with NaN/Infinity kept as
real floats instead of JSON’s string markers). measure_files’s
DataFrame can be written the same way with frame.to_feather("result.arrow").
For arrays already in memory, cp_anywhere.measure(...) is the lower-level
entry point that returns a MeasurementResult instead of a DataFrame;
it has matching to_json/to_csv/to_arrow methods
(see the Python API reference).
Segmentation#
cp_anywhere.identify_primary_objects(...) segments a 2D grayscale image
into labeled objects. You can pass those labels directly to measure.
See segmentation coverage for supported settings.
seg = cp_anywhere.identify_primary_objects(dna_image, threshold="otsu")
result = cp_anywhere.measure({"DNA": dna_image}, {"Nuclei": seg.labels})
The segmentation tests compare labels with CellProfiler 4.2.8 on synthetic and real microscopy fixtures.
Preview segmented objects#
Use preview_segmentation to draw object outlines on the input image or show
the objects as filled colors. The preview does not change the image or labels.
overlay = cp_anywhere.preview_segmentation(seg.labels, dna_image)
colored = cp_anywhere.preview_segmentation(seg.labels, mode="labels")
cp_anywhere.save_array(overlay, "segmentation-preview.png", bit_depth="No conversion")
To inspect the overlay in a notebook, use plt.imshow(overlay) with Matplotlib.
Run a pipeline on multiple fields#
Pass a supported CellProfiler pipeline and a mapping from image IDs to named channels. The channel names must match the pipeline. Paths and NumPy arrays both work.
image_sets = {
"A01-site1": {"DNA": "a01_s1_dna.tif", "Stain": "a01_s1_actin.tif"},
"A01-site2": {"DNA": "a01_s2_dna.tif", "Stain": "a01_s2_actin.tif"},
}
for field in cp_anywhere.run_batch("pipeline.cppipe", image_sets, workers=2):
if field.measurements is not None:
field.measurements.to_parquet(f"{field.image_id}.parquet")
Omit workers for serial execution. With more than one worker, backend="thread"
is the default. Use backend="process" in a Python script under an
if __name__ == "__main__": guard. Results arrive in input order and retain
their image IDs. For custom workflows, use load_pipeline(...).run(...) on a
single field or call the individual functions. See the
batch experiment
and the pipeline import limits.
The package is named cp-anywhere on PyPI, crates.io, and npm. The Rust
library uses cp_anywhere in imports. See the cross-runtime pipeline guide.
Project links#
Download the Python example notebook
Contents:
- Cell Profiling Anywhere
- Cell profiling in your browser
- Python API
- cp_anywhere.api
- cp_anywhere.io
- cp_anywhere.segment
- Segmentation preview
- cp_anywhere.cppipe
ColocalizationStepCppipeErrorExportToDatabaseStepGranularityStepIlluminationApplyImageIlluminationApplyStepIlluminationCalculateStepImageMathStepIntensityDistributionStepMeasurementStepPipelinePipelineModuleCheckRadialBinGroupSaveImagesStepSecondaryObjectsStepSegmentationStepTertiaryObjectsStepTextureStepinspect_pipeline()load_pipeline()
- Batch processing
- Project documentation
- Supported feature table
- M3 native Rust core
- M4 WASM feasibility and browser integration spike
- Browser integration: Zarr, ONNX Runtime Web, DuckDB-WASM
- M6 performance report
- Release process
- M5 implementation coverage dashboard
- Segmentation coverage dashboard
- Size and shape measurements
- Granularity
- CellProfiler pipeline (
.cppipe) import - Database export
- CI/CD