Worked examples

Examples are complete applications around Blockflow. They select inputs, assemble computations, execute them and publish outputs with metadata. They also make the assumptions and remaining limits visible.

Topic Start with
Camera and PSF calibration, unmixing, restoration Calibration and restoration
Classical and model-based masks and labels Segmentation
Image alignment, stitching and resampling Registration and geometry
Measurements and multi-stage image workflows Image analysis workflows

Each topic links to the repository README containing exact commands and expected outputs. Prefer a prepared fixture when one is provided: preparation can use small resident arrays while the processing command exercises the real chunk-backed path.

The examples are workspace packages. Build one with cargo run --release -p PACKAGE -- --help, rather than assuming a file under Rust’s single-file examples/ convention. Most inputs are OME image groups; some lower-level demonstrations take raw Zarr arrays. The example’s input contract is authoritative.

Read an example as an application boundary

The executable selects paths, channels, levels and physical units. The library operations supply numerical kernels and dependency contracts. Publication turns the completed images into a discoverable result. Keeping those roles separate helps identify what can be reused: a new acquisition may require different selection and reporting while using the same filter and scheduler.

Start with the example’s prepared input or tests when available. Preparation may allocate a whole small fixture; that is separate from the intended chunk-backed processing path. Inspect the actual processing command rather than assuming that a synthetic data generator demonstrates large-image I/O.

Before substituting real data, match dimensionality, dtype, channel alignment, physical scale and the algorithm’s statistical assumptions. A noise-free fixture establishes a numerical oracle, while a real crop establishes whether that model is useful for the acquisition. Both checks are necessary and they answer different questions.