Skip to content

docs: add DBS to the README and example generator - #73

Merged
g4bri3lDev merged 1 commit into
mainfrom
docs/dbs-examples
Oct 7, 2026
Merged

g4bri3lDev merged 1 commit into
mainfrom
docs/dbs-examples

Conversation

@g4bri3lDev

@g4bri3lDev g4bri3lDev commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Summary

Follow-up to #71: documents DBS refinement in the root README, with a visual comparison.

DBS comparison

  • New dbs_comparison.png (river scene, Spectra 6 V2, auto tone + gamut): original vs Burkes vs Burkes + DBS. The top row is full size; the bottom row is 4× nearest-neighbour crops. GitHub scales README images down, which blends dither patterns together, so the crops are what show the actual difference: Burkes under-places blue ink in the sky and DBS restores the right density. They also honestly show the trade-off, a few coloured specks in the treeline.
  • README: DBS added to Features and to the Python/JS quick-start snippets, with a short caption covering cost (~0.3 s per 800×480 panel on a multi-core machine vs ~30 ms).

Fixes found along the way

  • Algorithms grid was missing Dizzy (DitherMode 9). Added, and the grid is now 2 columns so cells stay legible when scaled down.
  • Latent generator bug: the Frankfurt "auto tone + gamut" panel called dither_image without tone/gamut, relying on defaults that are now off. Regenerating would have made it pixel-identical to the "no preprocessing" panel. It now passes tone="auto", gamut="auto" explicitly.
  • README Features didn't mention tone compression; Development didn't mention building the WASM before the JS tests. Both fixed.
  • .gitignore: the global *.png rule silently excluded new example images (the existing ones had been force-added). docs/examples/*.png is now exempt.

All example images are regenerated with the current library. The Frankfurt and colour-scheme images changed only in their dithered panels (the layout is identical), reflecting algorithm changes since they were last generated.

Regenerate with uv --project packages/python run python docs/examples/generate.py.

- New DBS comparison image (river scene, Spectra 6): original vs Burkes vs
  Burkes + DBS at full size, plus 4x nearest-neighbour crops so the pixel
  structure is visible despite GitHub's downscaling.
- Mention DBS in Features and in the Python/JS quick-start snippets.
- Add Dizzy to the algorithms grid (2 columns, so cells stay legible).
- Fix the generator's "auto tone + gamut" panel: it relied on tone/gamut
  defaulting to auto, which they no longer do, so a regeneration would have
  rendered it identical to the "no preprocessing" panel.
- Features: mention tone compression; Development: build the WASM
  (wasm-pack --target web) before the JS tests.
- Regenerate all example images with the current library.
- .gitignore: exempt docs/examples/*.png from the global *.png rule.
@g4bri3lDev
g4bri3lDev merged commit 23c55ce into main Oct 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant