average_hash 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmNkN2ViMWQzMjgyMmE2MTVlNGU1MzMyODU5YWI4M2VkMWZmZDg0NA==
+  data.tar.gz: !binary |-
+    YjdlODY4NDdmMjMzN2EwN2ZiY2QxOGZjY2E1MjE0MDAwZjRiNTkyMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTg4NzQyMjJiZDEyNmNjZDJjNjk5N2ZkYzhiMzg3MmFiYWQ1ZmY3NzBhNWIx
+    MjhjNzJjMTVhY2VjZDJiZTBmYTY3ZjQ4NmJiMzhhMGY1Mzc0NTdhNjU3Mjhh
+    MzBjMTgwYTczYjUyMzU5OTk4MGJlNWNjYTBiZmQwOTIzN2NhMDY=
+  data.tar.gz: !binary |-
+    ZmI4MTFiODBkZTcxMzJjMDk5ODEyNmZhNzZiODY5NmEyNDQwYjM5Y2UwYzI2
+    ZjQxMDQ3OTk3ZTRiMGMwMDEzNGVlMjBmODNjOTMyMmJjNWI4OGY5NmUwYTQw
+    OTQ4ZTA1OTk2OTA2ODRhZTE3OTVkNDc0NTRkYWEyODg5NDg5ZDY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+
+notifications:
+  emails:
+    - toru.iwashita@gmail.com
+  on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in average_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ToruIwashita
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# AverageHash
+
+Simple similarity calculation method of image. It is inspired by [Phashion](https://github.com/westonplatter/phashion).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'average_hash'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install average_hash
+
+## Usage
+
+Determine the similarity of image
+
+    require 'average_hash'
+    image_1 = AverageHash::Image.new(file_path_1)
+    image_2 = AverageHash::Image.new(file_path_2)
+    image_1.duplicate?(image_2)
+    => true
+
+If you want to set the threshold of hamming distance, you can do the following. (dafault threshold is 5)
+
+    image_1.duplicate?(image_2, threshold: 3)
+    => false
+
+Get the hamming distance between two images
+
+    image_1.distance_from(image_2)
+    => 4
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/average_hash.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'average_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "average_hash"
+  spec.version       = AverageHash::VERSION
+  spec.authors       = ["ToruIwashita"]
+  spec.email         = ["toru.iwashita@gmail.com"]
+  spec.description   = %q{Simple similarity calculation method of image}
+  spec.summary       = %q{Simple similarity calculation method of image}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rmagick"
+end

data/lib/average_hash.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+module AverageHash
+end
+
+require 'average_hash/version'
+require 'average_hash/image'
+require 'average_hash/hashing_strategy'

data/lib/average_hash/hashing_strategy.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+require 'RMagick'
+
+module AverageHash
+  class HashingStrategy
+    RESIZNING_SIZE = 8
+    PIXEL_ACQUISITION_SIZE = 1
+
+    INDEX_OF_R = 0
+    INDEX_OF_G = 1
+    INDEX_OF_B = 2
+
+    NTSC_COEFFICIENT_OF_R = 0.30
+    NTSC_COEFFICIENT_OF_G = 0.59
+    NTSC_COEFFICIENT_OF_B = 0.11
+
+    def initialize(file_path)
+      @image = Magick::Image.read(file_path).first.resize(RESIZNING_SIZE, RESIZNING_SIZE)
+    end
+
+    def generate_hash
+      (image_pixel_count.times).map { |i| gray_scaled_pixel(i) > average_pixel ? '1' : '0' }.join
+    end
+
+    private
+
+    def image_columns
+      @image.columns
+    end
+
+    def image_rows
+      @image.rows
+    end
+
+    def image_pixel_count
+      image_columns * image_rows
+    end
+
+    def average_pixel
+      gray_scaled_pixels = (image_pixel_count.times).map { |i| gray_scaled_pixel(i) }
+      gray_scaled_pixels.reduce(0, :+) / image_pixel_count
+    end
+
+    def gray_scaled_pixel(num)
+      px = pixel_at((num % RESIZNING_SIZE), (num / RESIZNING_SIZE))
+      px[INDEX_OF_R] * NTSC_COEFFICIENT_OF_R + px[INDEX_OF_G] * NTSC_COEFFICIENT_OF_G + px[INDEX_OF_B] * NTSC_COEFFICIENT_OF_B
+    end
+
+    def pixel_at(offset_of_x, offset_of_y)
+      @image.export_pixels(offset_of_x, offset_of_y, PIXEL_ACQUISITION_SIZE, PIXEL_ACQUISITION_SIZE)
+    end
+  end
+end

data/lib/average_hash/image.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module AverageHash
+  class Image
+    DEFAULT_DUPE_THRESHOLD = 5
+
+    attr_reader :file_path
+
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def fingerprint
+      @average_hash ||= HashingStrategy.new(@file_path).generate_hash
+      @average_hash.to_i(2)
+    end
+
+    def distance_from(other)
+      (fingerprint ^ other.fingerprint).to_s(2).count('1')
+    end
+
+    def duplicate?(other, opts = {})
+      threshold = opts[:threshold] || DEFAULT_DUPE_THRESHOLD
+      distance_from(other) <= threshold
+    end
+  end
+end

data/lib/average_hash/version.rb

@@ -0,0 +1,3 @@
+module AverageHash
+  VERSION = "0.1.0"
+end

data/spec/average_hash_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe AverageHash::Image do
+  context 'fingerprint use sample_1.jpg' do
+    it do
+      image_1 = AverageHash::Image.new(fixture_file_path('sample_1.jpg'))
+      expect(image_1.fingerprint).to eq 13158600607563222924
+    end
+  end
+
+  context 'fingerprint use sample_2.jpg' do
+    it do
+      image_2 = AverageHash::Image.new(fixture_file_path('sample_2.jpg'))
+      expect(image_2.fingerprint).to eq 7870530257777914161
+    end
+  end
+
+  context 'use two jpg images' do
+    before do
+      @image_1 = AverageHash::Image.new(fixture_file_path('sample_1.jpg'))
+      @image_2 = AverageHash::Image.new(fixture_file_path('sample_2.jpg'))
+    end
+
+    context '"sample_1" distance_from "sample_2"' do
+      it { expect(@image_1.distance_from(@image_2)).to eq 36 }
+    end
+
+    context '"sample_1" duplicate? "sample_2"' do
+      it { expect(@image_1.duplicate?(@image_2)).to be_falsey }
+    end
+
+    context '"sample_1" duplicate? "sample_2" with threshold 35' do
+      it { expect(@image_1.duplicate?(@image_2, threshold: 35)).to be_falsey }
+    end
+
+    context '"sample_1" duplicate? "sample_2" with threshold 36' do
+      it { expect(@image_1.duplicate?(@image_2, threshold: 36)).to be_truthy }
+    end
+  end
+
+  context 'use duplicate jpg image, "sample_1" duplicate? "sample_1"' do
+    it do
+      image_1_1 = AverageHash::Image.new(fixture_file_path('sample_1.jpg'))
+      image_1_2 = AverageHash::Image.new(fixture_file_path('sample_1.jpg'))
+      expect(image_1_1.duplicate?(image_1_2)).to be_truthy
+    end
+  end
+end
+
+describe AverageHash::HashingStrategy do
+  context 'generate_hash with argument "smaple_1.jpg"' do
+    it do
+      hashing_strategy = AverageHash::HashingStrategy.new(fixture_file_path('sample_1.jpg'))
+      expect(hashing_strategy.generate_hash).to eq '1011011010011100101111011000100100001011000010111000111110001100'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'average_hash'
+
+def fixture_file_path(file)
+  File.join(File.dirname(__FILE__), 'fixtures', file)
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: average_hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ToruIwashita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple similarity calculation method of image
+email:
+- toru.iwashita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- average_hash.gemspec
+- lib/average_hash.rb
+- lib/average_hash/hashing_strategy.rb
+- lib/average_hash/image.rb
+- lib/average_hash/version.rb
+- spec/average_hash_spec.rb
+- spec/fixtures/sample_1.jpg
+- spec/fixtures/sample_2.jpg
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Simple similarity calculation method of image
+test_files:
+- spec/average_hash_spec.rb
+- spec/fixtures/sample_1.jpg
+- spec/fixtures/sample_2.jpg
+- spec/spec_helper.rb