https://github.com/esimov/stackblur-go

A fast, almost Gaussian Blur implementation in Go
https://github.com/esimov/stackblur-go

blur gaussian golang image image-processing stackblur

Last synced: 6 days ago
JSON representation

A fast, almost Gaussian Blur implementation in Go

• Host: GitHub
• URL: https://github.com/esimov/stackblur-go
• Owner: esimov
• License: mit
• Created: 2017-09-01T07:51:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-12T14:59:41.000Z (about 1 year ago)
• Last Synced: 2024-12-21T06:08:50.629Z (13 days ago)
• Topics: blur, gaussian, golang, image, image-processing, stackblur
• Language: Go
• Homepage:
• Size: 674 KB
• Stars: 256
• Watchers: 7
• Forks: 20
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# stackblur-go

[![Go Reference](https://pkg.go.dev/badge/github.com/esimov/stackblur-go.svg)](https://pkg.go.dev/github.com/esimov/stackblur-go)

[![build](https://github.com/esimov/stackblur-go/actions/workflows/build.yml/badge.svg)](https://github.com/esimov/stackblur-go/actions/workflows/build.yml)

Go port of Mario Klingemann's [Stackblur](http://incubator.quasimondo.com/processing/fast_blur_deluxe.php) algorithm.

Stackblur is a compromise between Gaussian blur and Box blur, but it creates much better looking blurs than Box blur and it is ~7x faster than Gaussian blur.

Comparing to the Javascript implementation the Go version is at least 50% faster (depending on the image size and blur radius), applied on the same image with the same bluring radius.

### Benchmark

Radius       | Javascript  | Go

-------------|-------------|-------------

20           | ~15ms       | ~7.4ms

## Installation

First, install Go, set your GOPATH, and make sure $GOPATH/bin is on your PATH.

```bash

$ export GOPATH="$HOME/go"

$ export PATH="$PATH:$GOPATH/bin"

```

Next download the project and build the binary file.

```bash

$ go get -u -f github.com/esimov/stackblur-go

$ cd cmd && go build -o $GOPATH/bin/stackblur

```

#### CLI example

The provided CLI example supports the following flags:

```bash

$ stackblur --help

Usage of stackblur:

  -gif

    	Output Gif

  -in string

    	Source

  -out string

    	Destination

  -radius int

    	Radius (default 20)

```

The command below will generate the blurred version of the source image.

```bash

$ stackblur -in image/sample.png -out image/output.png -radius 10

```

The cli command supports a `-gif` flag, which if set as true it visualize the bluring process by outputting the result into a gif file.

## API

The usage of the API is very simple: you need to expose an image file and a blur radius to the `Process` function. This will return the blurred version of the original image.

```Go

stackblur.Process(src, blurRadius)

```

## Results

| Original image | Blurred image |

|:--:|:--:|

|  |  |

## License

This project is under the MIT License. See the [LICENSE](https://github.com/esimov/stackblur-go/blob/master/LICENSE) file for the full license text.