Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-langfield authored May 21, 2024
1 parent b405e32 commit cea2c66
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
## hexfft
![Screenshot 2024-05-21 at 1 00 10 PM](https://github.com/chris-langfield/hexfft/assets/34426450/b4eff5e9-2375-4d2c-a77e-5009efb34495)

# hexfft

A Python package aiming to provide an easy and efficient interface to various implementations of the [Hexagonal Fast Fourier Transform](https://en.wikipedia.org/wiki/Hexagonal_fast_Fourier_transform).

### Install
## Get started

#### Plot hexagonally sampled 2D signals
```
from hexfft import HexArray
from hexfft.plot import hexshow
import numpy as np
data = np.random.normal(size=(8, 6))
h = HexArray(data)
hexshow(h)
```
![Screenshot 2024-05-21 at 1 06 04 PM](https://github.com/chris-langfield/hexfft/assets/34426450/92d11a97-8b64-4d3f-9ac9-c612aa4b5437)

## Install

```
pip install hexfft
Expand All @@ -19,6 +35,7 @@ cd hexfft
pytest tests/
```

## Further reading
---------------------------------------
> R. M. Mersereau, "The processing of hexagonally sampled two-dimensional signals," in Proceedings of the IEEE, vol. 67, no. 6, pp. 930-949, June 1979, doi: 10.1109/PROC.1979.11356
Expand Down

0 comments on commit cea2c66

Please sign in to comment.