Walsh-hadamard transform

Compressing images with a Hadamard transform

Contents

• Description
• Contributing
• Acknowledgement
• Installation
  • Development
• How to run
  • Command line
  • Reading the PSNR figures
  • As a library
    • Other transforms
    • Writing your own
  • Examples
• Requirements
• Development commands
  • Coverage
• Releasing
• File formats
  • Input and output
  • Pickled pixels
  • The .cim container

Description

From Wikipedia: The Hadamard transform (also known as the Walsh–Hadamard transform, Hadamard–Rademacher–Walsh transform, Walsh transform, or Walsh–Fourier transform) is an example of a generalized class of Fourier transforms. It performs an orthogonal, symmetric, involutive, linear operation on 2m real numbers (or complex numbers, although the Hadamard matrices themselves are purely real).

The Hadamard transform can be regarded as being built out of size-2 discrete Fourier transforms (DFTs), and is in fact equivalent to a multidimensional DFT of size 2 × 2 × ⋯ × 2 × 2. It decomposes an arbitrary input vector into a superposition of Walsh functions.

The transform is named for the French mathematician Jacques Hadamard, the German-American mathematician Hans Rademacher, and the American mathematician Joseph L. Walsh.

The Hadamard transform is also used in data encryption, as well as many signal processing and data compression algorithms, such as JPEG XR and MPEG-4 AVC. In video compression applications, it is usually used in the form of the sum of absolute transformed differences. It is also a crucial part of Grover's algorithm and Shor's algorithm in quantum computing.

Contributing

See CONTRIBUTING.md for the development setup, the checks CI runs, and the conventions this codebase follows. Participation is covered by the Code of Conduct.

Acknowledgement

This code is partially based on the solution from ktisha/python2012

Installation

Requires Python 3.10 or newer.

pip install walsh

or, with uv:

uv add walsh          # into a project
uv tool install walsh # just the command line tool

The example script additionally needs matplotlib and Pillow, which are the demo extra: pip install "walsh[demo]".

Development

uv.lock is committed and CI installs from it with --locked, so a checkout reproduces exactly the environment CI uses:

uv sync --group dev --all-extras

--group dev brings in pytest, ruff and mypy; --all-extras adds the demo extra so examples/roundtrip.py runs too. Without uv:

pip install -e ".[demo]" -r requirements-dev.txt

How to run

Command line

walsh compress data/image.bmp data/transformed.cim
walsh extract  data/transformed.cim data/recreated.bmp

The format is taken from the filename suffix, so PPM works the same way, and a picture can be compressed from one format and restored as another:

walsh compress photo.ppm out.cim
walsh extract  out.cim restored.bmp     # PPM in, BMP out
walsh extract  out.cim restored.tif     # or TIFF out
walsh extract  out.cim restored.pam     # or PAM out
walsh extract  out.cim restored.npy     # or a bare NumPy array
walsh extract  out.cim restored.pkl     # or a pickle of rows of (r, g, b) tuples

Pickled pixels go in the same way, and a flat list of them, which does not carry its size, takes it from the command line:

walsh compress array.pkl  out.cim                            # a pickled NumPy array
walsh compress rows.pkl   out.cim                            # [[(r, g, b), ...], ...]
walsh compress pixels.pkl out.cim --width 400 --height 300   # [(r, g, b), ...]

A pickle is read through an allowlist and nothing in it is ever executed; see Pickled pixels.

compress accepts --packed-block-size (how many low-frequency coefficients per axis to keep -- lower is smaller and lossier), --y-block-size, --chroma-block-size, --coeff-removal, and --width with --height for input that cannot say how large it is. Add -v/-vv for progress logging, and see walsh compress -h for the full list.

Writes are atomic: output goes to a temporary file beside the destination and replaces it only on success, so a failed run leaves an existing file untouched. walsh also refuses to write over its own input, since both pipelines read the whole image before writing and would otherwise replace the original with a lossy reconstruction of itself.

The .cim container counts each channel's blocks in a 16-bit field, so at the default 8-pixel luma block an image must be under about 4.2 megapixels. Larger images are refused with a message naming the block size that would fit them: --y-block-size 16 roughly quadruples the ceiling, at some cost in detail.

--coeff-removal is the second, independent lossy knob: spectral coefficients smaller than the given magnitude are zeroed. It does not change the .cim file's size, because the format stores a fixed count of int16 values whether or not they are zero, but it makes the result far more compressible. On data/earth.ppm:

That table was measured at the default block sizes, 8 for luma and 16 for chroma, and the threshold is an absolute magnitude, so its effect depends on them. The surviving low-frequency coefficients grow with the block edge, and the same number prunes less at a larger one. The same --coeff-removal 25 on data/earth.ppm, with luma and chroma blocks set equal:

A threshold tuned against the first table and then combined with a larger --y-block-size has quietly stopped doing most of its work; retune it. Note also that it thresholds spectral coefficients, never the Hadamard matrix, whose entries all share one magnitude (0.35 at edge 8): a value at that scale is a no-op.

Reading the PSNR figures

PSNR is peak signal-to-noise ratio, the standard way to put a number on how much a lossy codec changed an image. It compares the reconstruction against the original pixel by pixel:

PSNR = 10 * log10(255**2 / MSE)

where MSE is the mean squared difference across every channel of every pixel, and 255 is the largest value an 8-bit channel can hold. It is measured in decibels, and higher is better: a perfect reconstruction has infinite PSNR, and every 3 dB gained means the mean squared error was halved.

Because the scale is logarithmic, small-looking differences matter. Going from 23 dB to 25 dB is not an 8% improvement, it is roughly a 37% reduction in error power. Equally, the near-identical 25.07 and 25.06 in the table above mean the first step of coefficient removal cost essentially nothing.

Rough expectations for 8-bit images, though they vary by content:

The figures here sit around 25 dB because the defaults are aggressive: each 8x8 luma block keeps 16 of its 64 coefficients and each 16x16 chroma block keeps 16 of 256. Raise --packed-block-size for a gentler setting.

One caveat worth knowing: PSNR measures arithmetic difference, not perceived quality. It is reproducible and easy to compare, which is why it is quoted here, but two images with the same PSNR can look noticeably different — it under- weights structured artefacts like block edges, which the eye picks out readily. Treat it as a consistent yardstick for comparing settings of this codec rather than an absolute measure of how good an image looks.

Exit codes follow the usual convention: 0 on success, 1 when the input cannot be processed (not a 24-bit BMP, truncated, unreadable), and 2 for a usage error such as a missing file or an unknown option.

As a library

from walsh import Task

Task().with_action("compress").with_input("data/image.bmp").with_output("out.cim").run()
Task().with_action("extract").with_input("out.cim").with_output("back.bmp").run()

Other transforms

Task takes the block transform as a keyword, so another transform can reuse the whole pipeline — the colour conversion, the padding, the crop to the low-frequency corner, the container — with only the transform swapped. Three ship with the package and are selected by name, in any case:

from walsh import Task

Task(transform="dct").with_action("compress").with_input("data/earth.ppm").with_output(
    "dct.cim"
).run()
Task(transform="dct").with_action("extract").with_input("dct.cim").with_output("back.ppm").run()

An unknown name is a ValueError that lists the known ones. "dct" and "haar" are ordinary floating-point matrix products, accurate to rounding; only "walsh" carries the bit-exactness guarantee.

The .cim does not record which transform wrote it. A file written with anything but the default must be extracted by a Task given the same transform. The walsh command never takes one, and will decode such a file without complaint into a degraded picture. This keyword is for experiments, not for files you hand to someone else.

examples/compare_transforms.py runs them over the Blue Marble sample. The byte count depends on the geometry alone, so each row is a like-for-like comparison of how much picture a transform packs into its first few coefficients:

The DCT wins throughout, which is why JPEG uses it; Walsh-Hadamard needs no multiplications and is exact. Haar ties Walsh-Hadamard wherever the kept size is a power of two, and that is mathematics rather than coincidence: the first 2, 4 or 8 Walsh functions and the first 2, 4 or 8 Haar functions span the same piecewise-constant subspace, so the two projections are the same picture.

Writing your own

The last column of that table is not in the package. Anything that subclasses Transform can be passed as an instance, and for a separable orthonormal transform MatrixTransform needs only the matrix:

import numpy as np
from walsh import MatrixTransform, Task


class Hartley(MatrixTransform):
    """cas(2*pi*i*k/n) / sqrt(n), with cas = cos + sin."""

    def matrix(self, size):
        angle = 2 * np.pi * np.outer(np.arange(size), np.arange(size)) / size
        return (np.cos(angle) + np.sin(angle)) / np.sqrt(size)


Task(transform=Hartley()).with_action("compress").with_input("data/earth.ppm").with_output(
    "hartley.cim"
).run()

It trails the others for an instructive reason: the codec keeps the top-left corner of each spectrum, which assumes rows rise in frequency, and a Hartley matrix puts half of its low frequencies in its last rows. A transform that is not a matrix product subclasses Transform directly and implements transform and inverse_transform for one square block; Task calls transform_stack and inverse_transform_stack, whose defaults loop over the blocks, so override those when a whole (count, edge, edge) stack can go through in one operation. with_coeff_removal is applied by the task, so it works for any transform.

Examples

examples/roundtrip.py compresses the sample image, restores it, and plots both images with their histograms side by side (needs the demo extra):

python examples/roundtrip.py

examples/compare_transforms.py prints the table above for any image, and needs numpy only:

python examples/compare_transforms.py [image]

Requirements

The package needs numpy and click -- BMP parsing is done by hand with struct, and click powers the command line interface. matplotlib and Pillow are needed only by the example script, and are declared as the demo extra. Versions are pinned in pyproject.toml; requirements.txt, requirements-demo.txt and requirements-dev.txt mirror them for plain pip install -r workflows, and tests/project/test_requirements_mirror.py fails if the two ever disagree. On pip 25.1 or newer, pip install -e ".[demo]" --group dev reads the same groups straight from pyproject.toml and needs no mirror at all.

Development commands

uv run pytest                          # test suite
uv run pytest --cov --cov-report=term-missing   # with coverage
uv run ruff check .                    # lint
uv run ruff format .                   # format
uv run mypy                            # strict type check
uv build                               # sdist + wheel into dist/

CI runs exactly these on every pull request, plus the test suite against Python 3.10 through 3.14.

Coverage

Coverage is measured with branch coverage on, and CI enforces a floor of 90% on every supported Python version. A pull request that drops below it fails the test jobs, which are required checks on master — so the badge above states what is actually guaranteed rather than a number that could drift.

Coverage is opt-in locally (--cov) so a plain pytest stays fast; CI always passes it.

Releasing

The version in pyproject.toml is the single source of truth. To cut a release, bump it, add the matching ## [x.y.z] section to CHANGELOG.md, and merge to master. The release workflow then tags v<version>, creates a GitHub Release with those notes, and publishes the sdist and wheel to PyPI using Trusted Publishing — no API token is stored in this repository.

Merges that do not change the version are a no-op, since PyPI permanently refuses to accept the same version twice.

File formats

Input and output

Every reader presents the same in-memory view -- RGB pixels, top row first -- whatever the file itself stores. BMP is the awkward one on both counts, storing blue-green-red samples in bottom-up rows, and BMPImage converts in each direction. That shared contract is what makes cross-format conversion work.

Pickled pixels

pickle.load and numpy.load(allow_pickle=True) run the program a pickle contains, with the power to import any module and call anything in it, so opening an untrusted pickle is running untrusted code. This package never does that. It reads the same files through an allowlist: lists, tuples, dicts, numbers and bytes need no lookups at all, and the only names a file may refer to are the handful NumPy's own pickles use to rebuild an array. Anything else is refused by name before it is called:

$ walsh compress evil.pkl out.cim
Error: unsupported pickle: it refers to posix.system; only lists, tuples, integers and NumPy arrays are read, and nothing in a pickle is ever executed

What a .pkl or .pickle may hold:

Lists and tuples are interchangeable at every level. Samples must be integers in 0-255, Python's or NumPy's; floats, booleans, out-of-range values and ragged rows are refused by name. A declared size is never silently dropped: input that carries its own size, in any format, must match it.

from walsh import Task

Task().with_input_size(400, 300).with_action("compress").with_input("pixels.pkl").with_output(
    "out.cim"
).run()

An object array saved by numpy.save, which only numpy.load(allow_pickle=True) opens, is a pickle inside a .npy and is read the same way. The writer produces rows of (r, g, b) tuples of plain int at protocol 4: any Python loads that without NumPy, and its bytes do not depend on which NumPy wrote it.

The .cim container

compress writes a .cim file: an atypical, project-specific container, so most commercial tools will not be able to read it. It stores the image dimensions, three block-layout descriptions (Y, Cb, Cr), and the retained Walsh-Hadamard coefficients as little-endian int16.

Note. .cim files written by 0.1.x are not compatible with 0.2.0. The in-memory pixel contract changed, so an old file extracted with 0.2.0 comes back with red and blue swapped and vertically flipped. Re-compress from the source image instead.