nxshock/colorcrop
1
0
Fork 0
mirror of https://github.com/nxshock/colorcrop.git synced 2025-07-02 00:23:44 +05:00
Code Issues Projects Releases Packages Wiki Activity Actions

README now in RST format

Browse source
This commit is contained in:
nxshock 2017-07-15 11:44:10 +05:00
parent 2882a3450f
commit 6b5251a781
2 changed files with 55 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -1,47 +0,0 @@
# colorcrop
[![Build Status](https://travis-ci.org/nxshock/colorcrop.svg?branch=master)](https://travis-ci.org/nxshock/colorcrop)
[![Coverage Status](https://coveralls.io/repos/github/nxshock/colorcrop/badge.svg)](https://coveralls.io/github/nxshock/colorcrop)
[![GoDoc](https://godoc.org/github.com/nxshock/colorcrop?status.svg)](https://godoc.org/github.com/nxshock/colorcrop)
A pure Go library for cropping images by removing borders with specified color.
## Installation
`go get -u github.com/nxshock/colorcrop`
## Usage
Import package with
```go
import "github.com/nxshock/colorcrop"
```
Crop white borders with 50% of thresold:
```go
croppedImage := colorcrop.Crop(
sourceImage, // for source image
color.RGBA{255, 255, 255, 255}, // crop white border
0.5) // with 50% thresold
```
You may use custom comparator of colors:
```go
croppedImage := colorcrop.CropWithComparator(
sourceImage, // for source image
color.RGBA{255, 255, 255, 255}, // crop white border
0.5, // with 50% thresold
colorcrop.CmpCIE76) // using CIE76 standart for defining color difference
```
Available comparators are:
- `CmpRGBComponents` - simple RGB components difference: `abs(r1-r2)+abs(g1-g2)+abs(b1-b2)` (default);
- `CmpEuclidean` - [Euclidean difference](https://en.wikipedia.org/wiki/Color_difference#Euclidean);
- `CmpCIE76` - difference of two colors defined in [CIE76 standart](https://en.wikipedia.org/wiki/Color_difference#CIE76).
## Examples
See [here](https://github.com/nxshock/colorcrop/blob/master/example_test.go).

55
README.rst Normal file
View file

@ -0,0 +1,55 @@
colorcrop
=========
.. image:: https://travis-ci.org/nxshock/colorcrop.svg?branch=master
:alt: Build Status
.. image:: https://coveralls.io/repos/github/nxshock/colorcrop/badge.svg
:alt: Coverage Status
.. image:: https://godoc.org/github.com/nxshock/colorcrop?status.svg
:alt: GoDoc
A pure Go library for cropping images by removing borders with specified color.
Installation
------------
``go get -u github.com/nxshock/colorcrop``
Usage
-----
Import package with:
.. code:: go
import "github.com/nxshock/colorcrop"
Crop white borders with 50% of thresold:
.. code:: go
croppedImage := colorcrop.Crop(
sourceImage, // for source image
color.RGBA{255, 255, 255, 255}, // crop white border
0.5) // with 50% thresold
You may use custom comparator of colors:
.. code:: go
croppedImage := colorcrop.CropWithComparator(
sourceImage, // for source image
color.RGBA{255, 255, 255, 255}, // crop white border
0.5, // with 50% thresold
colorcrop.CmpCIE76) // using CIE76 standart for defining color difference
Available comparators are:
* ``CmpRGBComponents`` -- simple RGB components difference: ``abs(r1-r2)+abs(g1-g2)+abs(b1-b2)`` (default);
* ``CmpEuclidean`` -- `Euclidean difference <https://en.wikipedia.org/wiki/Color_difference#Euclidean>`_;
* ``CmpCIE76`` -- difference of two colors defined in `CIE76 standard <https://en.wikipedia.org/wiki/Color_difference#CIE76>`_.
Examples
--------
See `here <https://github.com/nxshock/colorcrop/blob/master/example_test.go>`_.