https://github.com/ksk001100/pixel_matcher

Library to compare images and generate difference image files
https://github.com/ksk001100/pixel_matcher

diff-image image-processing imagemagick rmagick ruby

Last synced: about 2 months ago
JSON representation

Library to compare images and generate difference image files

• Host: GitHub
• URL: https://github.com/ksk001100/pixel_matcher
• Owner: ksk001100
• License: mit
• Created: 2019-12-30T11:30:51.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-20T05:08:02.000Z (about 2 years ago)
• Last Synced: 2024-05-02T04:41:54.935Z (9 months ago)
• Topics: diff-image, image-processing, imagemagick, rmagick, ruby
• Language: Ruby
• Homepage:
• Size: 4.27 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# PixelMatcher

![](https://ruby-gem-downloads-badge.herokuapp.com/pixel_matcher)

[![Gem Version](https://badge.fury.io/rb/pixel_matcher.svg)](https://badge.fury.io/rb/pixel_matcher)

[![Build Status](https://travis-ci.org/ksk001100/pixel_matcher.svg?branch=master)](https://travis-ci.org/ksk001100/pixel_matcher)

![](https://img.shields.io/github/issues/ksk001100/pixel_matcher.svg)

![](https://img.shields.io/github/forks/ksk001100/pixel_matcher.svg)

![](https://img.shields.io/github/license/ksk001100/pixel_matcher.svg)

Library to compare images and generate difference image files

![](images/generate.png)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'pixel_matcher'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install pixel_matcher

## Usage

### Library

```ruby

require 'pixel_matcher'

# from rmagick image

require 'rmagick'

diff = PixelMatcher::DiffImage.new(Magick::Image.read('img1.png').first, Magick::Image.read('img2.png').first)

diff.export('diff.png') # or mode: :only

diff.export('gray_scale.png', mode: :gray_scale)

diff.export('compare.png', mode: :compare)

# from file path

diff = PixelMatcher::DiffImage.from_path('img1.png', 'img2.png')

diff.export('diff.png') # or mode: :only

diff.export('gray_scale.png', mode: :gray_scale)

diff.export('compare.png', mode: :compare)

# from blob

diff = PixelMatcher::DiffImage.from_blob(File.read('img1.png'), File.read('img2.png'))

diff.export('diff.png') # or mode: :only

diff.export('gray_scale.png', mode: :gray_scale)

diff.export('compare.png', mode: :compare)

```

### CLI tool

```bash

$ pixel_matcher img1.png img2.png diff.png

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ksk001100/pixel_matcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the PixelMatcher project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksk001100/pixel_matcher/blob/master/CODE_OF_CONDUCT.md).