image_svd 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c7595bcaa0980e88306b17c334eb96e97cc9d03
-  data.tar.gz: e5fd5e67bd0e4ae9138d736640aff240ea6d1e28
+  metadata.gz: 7c6be55c37295a68be501d5eb609175825105b52
+  data.tar.gz: 33fa7ce261ed05d54123c04ae9bbca9be486b5ba
 SHA512:
-  metadata.gz: c5c5d15ea75980e4c0a785695e9c84909b6c8ae6796b18d0ee7484c76961e72cc8ded4c6b6261058058a125b88a3054a290652c35076a97739ce3c03ca7e5eef
-  data.tar.gz: 065244d4de86a95ea5e8cb6da141f177b23d94480a817f6a6a8b7eaa9e3ec0839284ce2dae41684efb1cb9a4d1ee573b2aced5cbc7abf3926e6c43e246b6cdc8
+  metadata.gz: fbca7cbe89abcccbf9f9a916163b1b3ee122fdd3060b821c1a1e237e783f239b85aa63f081bae7d8574337a00f30196cf9ce11e00a706ab964f3d292de28d479
+  data.tar.gz: 23083c717ed0fc46950cabd0551c82d38f5ceef2ca0c8dc1a5c3fad0cf1f96f7d3ce1f67c7809aae48b2e301eab9abba4a18fe1ddfaefa5285b4db3b02395dec

data/README.md

@@ -1,6 +1,12 @@
-# ImageSvd
+# image_svd
 
-TODO: Write a gem description
+A utility to compress images, with interesting [Richter](https://artsy.net/artist/gerhard-richter)-esque blur effects at high compression.
+
+#### [About page](http://ilyakava.tumblr.com/post/86408872127/gerhard-richter-svd-and-me).
+
+![woman with umbrella almost](http://i.imgur.com/tvhJRj5.gif)
+
+The above image ([source](http://pixel.nymag.com/imgs/thecut/slideshows/lookbooks/jackie-kennedy/c/jackie-kennedy-085.nocrop.w1800.h1330.jpg)) was chosen for its resemblance to [Woman with Umbrella](http://www.gerhard-richter.com/art/paintings/photo_paintings/detail.php?5499)
 
 ## Installation
 
@@ -18,7 +24,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`image_svd --help`
+
+A prerequisite is to have [imagemagick](http://www.imagemagick.org/), and a ruby version 1.9.2 or greater installed.
+
+`image_svd -i ~/Downloads/svd_photos/in_RichterfuneralM.jpg -n 10`
+
+will create a new image in the current directory using 10 singular values.
+
+Be warned! Compression is by no means quick! A 200x300 image takes 15 seconds on my computer. Finding the eigenvalues of a matrix is no easy computational task (O(n!) by brute force, O(n<sup>2.3</sup>) by super fancy approximation).
+
+You may also specify a (ruby-style inclusive) range of singular values to output images with, ex:
+
+`image_svd -i ~/Downloads/svd_photos/in_RichterfuneralM.jpg -n 1..10`
+
+This will lead to 10 images being output, and it is 10 times faster than calling the command 10 times since the most costly step (finding eigenvalues) is only done once.
 
 ## Contributing
 

data/lib/image_svd/cli.rb

@@ -7,10 +7,11 @@ module ImageSvd
     # rubocop:disable MethodLength
     def run(opts)
       if opts[:read] == true
-        app = ImageSvd::ImageMatrix.new_from_svd_savefile(opts[:input_file])
+        app = ImageSvd::ImageMatrix.new_from_svd_savefile(opts)
         app.to_image(opts[:output_name])
       else
-        app = ImageSvd::ImageMatrix.new(opts[:num_singular_values])
+        opts = process_options(opts)
+        app = ImageSvd::ImageMatrix.new(opts[:singular_values])
         app.read_image(opts[:input_file])
         if opts[:archive] == true
           app.save_svd(opts[:output_name])
@@ -19,6 +20,14 @@ module ImageSvd
         end
       end
     end
+
+    def process_options(opts)
+      i, valid_i = [opts[:num_singular_values].to_s, /^\d+\.\.\d+$|^\d+$/]
+      fail 'invalid --num-singular-values option' unless i.match valid_i
+      vs = i.split('..').map(&:to_i)
+      vs = (vs.length == 1 ? vs : ((vs.first)..(vs.last)).to_a)
+      opts.merge(singular_values: vs)
+    end
   end
   # rubocop:enable MethodLength
 
@@ -45,8 +54,9 @@ module ImageSvd
         opt :num_singular_values,
             'The number of singular values to keep for an image. Lower'\
               ' numbers mean lossier compression; smaller files and more'\
-              ' distorted images.',
-            default: 50,
+              ' distorted images. You may also provide a range ruby style,'\
+              ' (ex: 1..9) in which case many images will be output.',
+            default: '50',
             short: '-n'
         opt :output_name,
             'A path/name for an output file (Extension will be ignored).'\

data/lib/image_svd/image_matrix.rb

@@ -10,11 +10,13 @@ module ImageSvd
   class ImageMatrix
     # rubocop:disable SymbolName
     # rubocop:disable VariableName
-    attr_reader :num_singular_values
+    attr_reader :singular_values
     attr_accessor :sigma_vTs, :us, :m, :n
 
-    def initialize(num_singular_values)
-      @num_singular_values = num_singular_values
+    def initialize(singular_values)
+      fail 'not enough singular values' if singular_values.length.zero?
+      @singular_values = singular_values
+      @num_singular_values = singular_values.max
     end
 
     def read_image(image_path)
@@ -61,20 +63,24 @@ module ImageSvd
     end
     # rubocop:enable MethodLength
 
-    def reconstruct_matrix
+    def reconstruct_matrix(num_singular_values = nil)
+      num_singular_values ||= @num_singular_values
       zero_matrix = Matrix[*Array.new(@n) { Array.new(@m) { 0 } }]
-      (0...@num_singular_values).reduce(zero_matrix) do |acc, idx|
+      (0...num_singular_values).reduce(zero_matrix) do |acc, idx|
         acc + (@us[idx] * @sigma_vTs[idx])
       end.transpose
     end
 
     def to_image(path)
-      out_path = extension_swap(path, 'jpg')
-      intermediate = extension_swap(path, 'pgm', '_tmp_outfile')
-      cleansed_matrix = matrix_to_valid_pixels(reconstruct_matrix)
-      PNM::Image.new(cleansed_matrix).write(intermediate)
-      %x(convert #{intermediate} #{out_path})
-      %x(rm #{intermediate})
+      puts 'writing images...' if @singular_values.length > 1
+      @singular_values.each do |sv|
+        out_path = extension_swap(path, 'jpg', "_#{sv}_svs")
+        intermediate = extension_swap(path, 'pgm', '_tmp_outfile')
+        cleansed_matrix = matrix_to_valid_pixels(reconstruct_matrix(sv))
+        PNM::Image.new(cleansed_matrix).write(intermediate)
+        %x(convert #{intermediate} #{out_path})
+        %x(rm #{intermediate})
+      end
       true
     end
 
@@ -111,9 +117,11 @@ module ImageSvd
 
     # @todo error handling code here
     # @todo serialization is kind of silly as is
-    def self.new_from_svd_savefile(path)
-      h = JSON.parse(File.open(path, &:readline))
-      instance = new(h['sigma_vTs'].length)
+    def self.new_from_svd_savefile(opts)
+      h = JSON.parse(File.open(opts[:input_file], &:readline))
+      svals = [opts[:singular_values], h['sigma_vTs'].size].compact.sort.uniq
+      valid_svals = svals.reject { |v| v > h['sigma_vTs'].size }
+      instance = new(valid_svals)
       instance.sigma_vTs = h['sigma_vTs']
         .map { |arr| Vector[*arr.flatten].covector }
       instance.us = h['us'].map { |arr| Vector[*arr.flatten] }

data/lib/image_svd/version.rb

@@ -1,4 +1,4 @@
 # This module holds the gem's code
 module ImageSvd
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/cli_spec.rb

@@ -15,17 +15,17 @@ describe 'CLI' do
         num_singular_values: 2,
         output_name: conv
       )
-      i = ImageSvd::ImageMatrix.new(2)
+      i = ImageSvd::ImageMatrix.new([2])
       i.read_image(orig)
-      i2 = ImageSvd::ImageMatrix.new(2)
-      i2.read_image(File.new("#{conv}.jpg"))
+      i2 = ImageSvd::ImageMatrix.new([2])
+      i2.read_image(File.new("#{conv}_2_svs.jpg"))
       diff_matrix = i.reconstruct_matrix - i2.reconstruct_matrix
       diff_matrix.to_a.flatten.each do |diff_component|
         diff_component.abs.should be < 5
       end
 
       # cleanup
-      %x(rm #{conv}.jpg)
+      %x(rm #{conv}_2_svs.jpg)
     end
 
     it 'archives, reads, and converts an image without too great errors' do
@@ -34,25 +34,25 @@ describe 'CLI' do
       cli.run(
         input_file: orig,
         archive: true,
-        num_singular_values: 2,
+        num_singular_values: '2',
         output_name: conv
       )
       # read archive and write and image
       cli.run(
         input_file: "#{conv}.svdim",
         read: true,
-        output_name: "#{conv}_2"
+        output_name: "#{conv}_two"
       )
-      i = ImageSvd::ImageMatrix.new(2)
+      i = ImageSvd::ImageMatrix.new([2])
       i.read_image(orig)
-      i2 = ImageSvd::ImageMatrix.new(2)
-      i2.read_image(File.new("#{conv}_2.jpg"))
+      i2 = ImageSvd::ImageMatrix.new([2])
+      i2.read_image(File.new("#{conv}_two_2_svs.jpg"))
       diff_matrix = i.reconstruct_matrix - i2.reconstruct_matrix
       diff_matrix.to_a.flatten.each do |diff_component|
         diff_component.abs.should be < 5
       end
       # cleanup
-      %x(rm #{conv}_2.jpg #{conv}.svdim)
+      %x(rm #{conv}_two_2_svs.jpg #{conv}.svdim)
     end
   end
 end

data/spec/image_matrix_spec.rb

@@ -8,7 +8,7 @@ describe ImageSvd::ImageMatrix do
   end
 
   it 'recovers a 2x3 matrix' do
-    i = ImageSvd::ImageMatrix.new(2)
+    i = ImageSvd::ImageMatrix.new([2])
     i.decompose(@m)
     rounded_matrix = Matrix[*i.matrix_to_valid_pixels(i.reconstruct_matrix)]
     # due to numerical instability, even a 2x3 matrix needs to be rounded

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_svd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ilya Kavalerov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pnm