Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix readme #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix readme #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#Pyblur
##Python image blurring routines.
# Pyblur
## Python image blurring routines.
Pyblur is a collection of simple image blurring routines.<br>
It supports Gaussian, Disk, Box, and Linear Motion Blur Kernels as well as the Point Spread Functions
used in [Convolutional Neural Networks for Direct Text Deblurring](http://www.fit.vutbr.cz/~ihradis/CNN-Deblur/).<br>
Expand All @@ -11,14 +11,14 @@ pypi: [https://pypi.python.org/pypi?:action=display&name=pyblur&version=0.2.3](h



##Installation
## Installation
From Pip: `pip install pyblur`<br>
Or alternatively `git clone` this repo and run locally

##Usage
## Usage
from pyblur import *

###Gaussian Blur
### Gaussian Blur
Blurs image using a Gaussian Kernel

blurred = GaussianBlur(img, bandwidth)
Expand All @@ -27,7 +27,7 @@ Randomized kernel bandwidth (between 0.5 and 3.5)

blurred = GaussianBlur_random(img)

###Defocus (Disk) Blur
### Defocus (Disk) Blur
Blurs image using a Disk Kernel

blurred = DefocusBlur(img, kernelsize)
Expand All @@ -37,7 +37,7 @@ Randomized kernel size (between 3 and 9)
blurred = DefocusBlur_random(img)


###Box Blur
### Box Blur
Blurs image using a Box Kernel

blurred = BoxBlur(img, kernelsize)
Expand All @@ -47,12 +47,12 @@ Randomized kernel size (between 3 and 9)
blurred = BoxBlur_random(img)


###Linear Motion Blur
### Linear Motion Blur
Blurs image using a Line Kernel

blurred = LinearMotionBlur(img, dim, angle, linetype)

####Parameters
### Parameters
* `dim` Kernel Size: {3,5,7,9} <br>
* `angle` Angle of the line of motion. Will be floored to the closest one available for the given kernel size. <br>
* `linetype = {left, right, full}` Controls whether the blur kernel will be applied in full or only the left/right halves of it. <br>
Expand All @@ -61,13 +61,13 @@ Randomized kernel size, angle, and line type

blurred = LinearMotionBlur_random(img)

### PSF Blur
### PSF Blur
Blurs image using one of the Point Spread Functions (Kernels) used in:<br>
[Convolutional Neural Networks for Direct Text Deblurring](http://www.fit.vutbr.cz/~ihradis/CNN-Deblur/)

blurred = PsfBlur(img, psfid)

####Parameters
### Parameters
* `psfid` Id of the Point Spread Function to apply [0, 99] <br>


Expand All @@ -76,7 +76,7 @@ Randomized kernel size, angle, and line type
blurred = PsfBlur_random(img)


###Random Blur
### Random Blur
Randomly applies one of the supported blur types, with a randomized bandwidth/strenght.

blurred = RandomizedBlur(img)