From ace80ae1c8f22fc0657859a4904c27f593089873 Mon Sep 17 00:00:00 2001 From: Chris Langfield <34426450+chris-langfield@users.noreply.github.com> Date: Tue, 21 May 2024 13:14:00 -0400 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 7fb99c9..2e47353 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,29 @@ hexshow(h) ``` ![Screenshot 2024-05-21 at 1 06 04 PM](https://github.com/chris-langfield/hexfft/assets/34426450/92d11a97-8b64-4d3f-9ac9-c612aa4b5437) +#### Perform FFT for rectangularly or hexagonally periodic signals + +```python +from hexfft import fft, ifft + +X = fft(h) +X_hx = fft(h, periodicity="hex") +``` + +#### Operate on a 3D stack + +```python +from hexfft import FFT + +shape = (32, 32) + +fftobj = FFT(shape, periodicity="hex") # or "rect" +X = fftobj.forward(x) +xx = fftobj.inverse(X) + +... +``` + ## Install ```