ph 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a7e900bca90ab2c70029559c46848add5f8384a2c60040f012b1ac16691024
-  data.tar.gz: 4f38f845987a7c33e6d8adb70766e0ea0a0f9758a0efe0e01655370f488f0b96
+  metadata.gz: 24b368462e37a0884ab35c35b3fee219c3463e051c4b51a543678412938c46e2
+  data.tar.gz: 6e91f21c7e6c1d59259b5eb45e67b4c6e6716346d2c1389ca6a221d80fe216b3
 SHA512:
-  metadata.gz: 47c53e0c8a34d0a5c1cbde470000b5de32a246dae9d3f15582ed024b9aaed938fdfcb8b141d5ec845b505765a2ccbab1b46f31b6173886d00c3ff3fcfc1fd7e2
-  data.tar.gz: 76d82783e82eb7f8d321a79dd21e6a72cafc5014381a6498dcb217f3a29c3c9ab3f1ec9fbf8b4099e31677e1919b4ee1f836e10f520c574a966f06c3762dea86
+  metadata.gz: afb8a6f5f61b52a041934f1bb71764b6067665f8f0b505f8772d6a3a11d25565e313d1cb03fb3ff77ab436be379353275fe163241238f0b145c94eb074334e07
+  data.tar.gz: e2eeeb235206cc887f3f303702faf11443f8b3e5127fdcd77c21fa6477847bf29ee02ad24a2c64133e74d784f0a5252288ab896a85a4e155a506c14d8e1b7918

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Makefile

@@ -9,5 +9,8 @@ build:
 publish: build
 	gem push *.gem
 
+console:
+	irb -Ilib -rph
+
 test:
 	ruby -Ilib:spec spec/*_spec.rb

data/README.md

@@ -0,0 +1,60 @@
+# PH
+_Perceptual Hashing_
+
+## Install
+
+```bash
+gem install ph
+```
+
+## Usage
+
+`PH` Generates a perceptual hash from an array of pixels.
+The way you get that pixel data is up to you. Different techniques can shield different values.
+Hashes exist on a similar space but different reads could yield different (subtle) hashes.
+
+### Distance
+
+Since hashes exist on a metric space you can measure how far a hash is from another.
+You can use the hamming gem for calculations if needed
+
+```ruby
+Hamming.distance(hash_a, hash_b)
+
+# You can also transform hashes based on your storage:
+Hamming.vector_to_hash(hash)
+Hamming.hash_to_vector(vector)
+```
+
+### Vips
+
+```ruby
+size = 64
+img = Vips::Image.new_from_file(file)
+width, height = img.width, img.height
+w_scale, v_scale = size.fdiv(width), size.fdiv(height)
+
+img = img
+  .resize(w_scale, vscale: v_scale)
+  .colourspace(:grey16)
+
+pixels_2d = img.to_a.map(&:flatten)
+
+PH.hash(pixels_2d)
+# => "859091ce633aaebb"
+```
+
+### RMagick
+
+```ruby
+img = Magick::ImageList.new(file)
+size = 64
+img = img
+  .scale(size, size)
+  .dispatch(0, 0, size, size, "I")
+  .each_slice(size)
+  .to_a
+
+PH.new(img).vector
+# => [1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 1, 1, 0, 1, 1]
+```

data/lib/ph.rb

@@ -3,9 +3,25 @@
 class PH
   attr_reader :pixels, :size
 
-  def initialize(pixels_2d, size: 64)
+  NotGreyscaleError = Class.new(StandardError)
+  IncorrectDimensionsError = Class.new(StandardError)
+
+  class << self
+    def hash(pixels_2d)
+      new(pixels_2d).hash
+    end
+
+    def vector(pixels_2d)
+      new(pixels_2d).vector
+    end
+  end
+
+  def initialize(pixels_2d)
     @pixels = pixels_2d
-    @size = size
+    @size = pixels_2d.size
+
+    raise NotGreyscaleError if pixels_2d.flatten.count != @size**2
+    raise IncorrectDimensionsError if !(Math.sqrt(size) % 8).zero?
   end
 
   def hash

data/ph.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "ph"
-  s.version           = "0.0.1"
+  s.version           = "0.1.0"
   s.summary           = "Perceptual Hashing"
   s.authors           = ["elcuervo"]
   s.licenses          = %w[MIT]

data/spec/ph_spec.rb

@@ -4,30 +4,32 @@ describe PH do
   let(:file) { "spec/image.jpg" }
   let(:size) { 64 }
 
-  before do
-    img = Vips::Image.new_from_file(file)
-    width, height = img.width, img.height
-    w_scale, v_scale = size.fdiv(width), size.fdiv(height)
+  describe "hashing an image" do
+    before do
+      img = Vips::Image.new_from_file(file)
+      width, height = img.width, img.height
+      w_scale, v_scale = size.fdiv(width), size.fdiv(height)
 
-    # Rescale to 64x64 and greyscale
-    img = img.resize(w_scale, vscale: v_scale).colourspace(:grey16)
-    # Ensure a 2D plane
-    @pixels_2d = img.to_a.map(&:flatten)
-  end
+      # Rescale to 64x64 and greyscale
+      img = img.resize(w_scale, vscale: v_scale).colourspace(:grey16)
+      # Ensure a 2D plane
+      @pixels_2d = img.to_a.map(&:flatten)
+    end
 
-  subject { PH.new(@pixels_2d) }
+    subject { PH.new(@pixels_2d) }
 
-  it "#hash" do
-    assert_equal "859091ce633aaebb", subject.hash
-  end
+    it "#hash" do
+      assert_equal "859091ce633aaebb", subject.hash
+    end
 
-  it "#vector" do
-    vector = [
-      1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1,
-      0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 1, 1, 0,
-      1, 1
-    ]
+    it "#vector" do
+      vector = [
+        1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1,
+        0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 1, 1, 0,
+        1, 1
+      ]
 
-    assert_equal vector, subject.vector
+      assert_equal vector, subject.vector
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ph
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - elcuervo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vips
@@ -31,7 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Makefile
+- README.md
 - lib/ph.rb
 - ph.gemspec
 - spec/image.jpg