yearbook 0.2.3 → 0.3.0

data/README.md

@@ -1 +1,30 @@
-A wrapper around [ruby-opencv](https://github.com/ruby-opencv/ruby-opencv) and [rmagick](http://rmagick.rubyforge.org/) (which themselves are wrappers around [OpenCV](http://opencv.org/) and [ImageMagick](http://www.imagemagick.org) + [GraphicsMagick](http://www.graphicsmagick.org/)) for producing face-cropped images from a source image.
+# Yearbook
+
+A convenience for cropping and outputting images, by Dan Nguyen ([@dancow](https://twitter.com/dancow))
+
+A very thin wrapper around [ruby-opencv](https://github.com/ruby-opencv/ruby-opencv) and [rmagick](http://rmagick.rubyforge.org/) (which themselves are wrappers around [OpenCV](http://opencv.org/) and [ImageMagick](http://www.imagemagick.org) + [GraphicsMagick](http://www.graphicsmagick.org/)) for producing face-cropped images from a source image.
+
+This is in very-early stage...I'm using it mostly as a quickie image cropper for various projects, as well as a way to learn the cool [thor](https://github.com/erikhuda/thor) gem.
+
+## Installation
+
+Load all the dependencies mentioned above (ha!)
+
+Then:
+
+`gem install yearbook`
+
+## Usage
+
+### In Ruby
+
+  require 'yearbook'
+  
+  image = Yearbook::Image.new('path/to/somebody.jpg')
+  image.clip_and_print_best_face('output/to/somebodys-face.jpg')
+
+### Command-line tool
+
+  yearbook face george-washington.jpg
+  # will print out to "george-washington-face.jpg" by default
+

data/Rakefile

@@ -1,5 +1,6 @@
 # encoding: utf-8
-$:.unshift File.dirname(File.expand_path './lib', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'rubygems'
 require 'bundler'
@@ -23,6 +24,7 @@ Jeweler::Tasks.new do |gem|
   gem.email = "dansonguyen@gmail.com"
   gem.authors = ["dannguyen"]
   gem.files.exclude 'spec/fixtures/images/*.jpg' # exclude temporary directory
+  gem.executables << 'yearbook'
 
   # dependencies defined in Gemfile
 end
@@ -36,7 +38,6 @@ end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/bin/yearbook

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require './lib/yearbook'
+
+begin
+  Yearbook::CLI.start(ARGV)
+end

data/lib/yearbook.rb

@@ -1,7 +1,8 @@
 require "opencv"
 require 'hashie'
 require 'active_support' # I know, this makes me bad
-require 'yearbook/image'
+require_relative 'yearbook/image'
+require_relative 'yearbook/cli'
 
 include OpenCV
 

data/lib/yearbook/att_hash.rb

@@ -1,4 +1,6 @@
 require 'delegate'
+require 'hashie'
+
 class AttHash < SimpleDelegator
   def initialize
     @hsh = {}

data/lib/yearbook/classifier.rb

@@ -1,5 +1,7 @@
+require 'active_support/core_ext/string'
+
 module Yearbook
-  module Classifier
+  class Classifier
     
     DATA_DIR = File.expand_path('../../../data/classifiers', __FILE__ )
     DATA_FILES = {
@@ -7,20 +9,33 @@ module Yearbook
 
     }
 
+    attr_reader :filename
+
+    def initialize(fname)
+      @filename = fname
 
-    # returns an array of detected objects
-    def self.detect_objects(cv_image, object_type)
-      detector = load_detector(object_type.to_sym)
+      @classifier =  load_classifier(@filename)
+    end
 
-      detector.detect_objects(cv_image)
+    def detect_objects(cvimg)
+      @classifier.detect_objects(cvimg)
     end
 
 
-    def self.load_detector(object_type)
-      fname = DATA_FILES[object_type]
-      puts fname
-      OpenCV::CvHaarClassifierCascade::load( fname )
+
+
+    # convenience
+    # will also pluralize anything
+    def self.of(object_type)
+      object_name = object_type.to_s.pluralize.to_sym
+
+      return self.new DATA_FILES[object_name]
     end
 
+
+    private
+    def load_classifier(fname)
+      OpenCV::CvHaarClassifierCascade::load(fname )
+    end
   end
 end

data/lib/yearbook/cli.rb

@@ -0,0 +1,26 @@
+require 'thor'
+
+module Yearbook
+  class CLI < Thor
+    desc 'hello', 'from'
+    def hello(from)
+      puts "Hello world, from: #{from}"
+    end
+
+    desc 'face', 
+    %q{ Provide the path to an image with a face in it:
+        yearbook face /path/to/photo.jpg /path/out/face-in-photo.jpg
+    }
+    def face(path, outpath=nil)
+      fpath = File.expand_path(path)
+      @image = Image.new(fpath)
+
+      outpath ||= path.sub(/(?=\.\w*$)/, '-face')
+      # eh overwrite it anyway
+      @image.clip_and_print_best_face(outpath)
+    end
+  end
+
+
+end
+

data/lib/yearbook/detected_object.rb

@@ -0,0 +1,26 @@
+# NOT USED YET
+# module Yearbook
+#   class DetectedObject
+
+#     attr_reader @x, @y, @width, @height
+
+#     # args can either be one CvMat object, 
+#     # or x,y,w,h dimensions
+#     def initialize(*args)
+
+#       case args.count
+#       when 1
+#         # CVMat
+#       when 4
+#         @x = x
+#         @y = y
+#         @width = w
+#         @height = h
+#       else
+#         raise "Expected 1 or 4 arguments, not #{args.count}"
+#       end
+#     end
+
+
+#   end
+# end

data/lib/yearbook/detection.rb

@@ -0,0 +1,13 @@
+require_relative 'detection/collection'
+
+module Yearbook
+  module Detection
+  end
+
+  class << self
+    def DetectionCollection(cvseq, obj_type = nil)
+      Detection::Collection.new(cvseq)
+    end
+  end
+end
+

data/lib/yearbook/detection/collection.rb

@@ -0,0 +1,20 @@
+require 'delegate'
+
+module Yearbook
+  module Detection
+    class Collection < SimpleDelegator
+      def initialize(cvseq, opts={})
+        @cv_seq = cvseq
+
+        super(@cv_seq)
+      end
+
+      # returns just one of the CvAvgComps
+      def best
+        sort_by{|c| c.width * c.height}.reverse.first
+      end
+    
+
+    end
+  end
+end

data/lib/yearbook/detector.rb

@@ -0,0 +1,21 @@
+require_relative 'classifier'
+require_relative 'detection'
+
+module Yearbook
+  module Detector
+
+    class << self 
+      # returns an array of detected objects
+      def detect_objects(cv_image, object_type)
+        x = Classifier.of(object_type).detect_objects(cv_image)
+
+
+        return Yearbook.DetectionCollection(x, object_type)
+      end
+
+      def load_cv(fname)
+        IplImage::load(fname)
+      end
+    end
+  end
+end

data/lib/yearbook/image.rb

@@ -1,115 +1,150 @@
-require 'rmagick'
-require 'hashie'
 require_relative 'att_hash'
-require_relative 'classifier'
-
-
-
+require_relative 'manipulator'
+require_relative 'detector'
 
 module Yearbook
   class Image
 
-    attr_reader :filename
+    attr_reader :filename, :clips
     def initialize(fname)
-      @filename = fname
-      @objects = []
+      @filename = fname      
     end
 
 
-    def detect_objects(obj_type)
-      @objects = Classifier.detect_objects(cv_object, obj_type).to_a
+
+    # args is empty for now...
+    def clip(obj_type, *args, &blk)
+      @clips = detect_and_collect(cv_image, obj_type)
+    end
+
+
+
+
+    def clipped?; @clips.count > 0; end
+
+    # just the original image
+    def print(fname, &blk)
+      write_images(magick_image, fname, &blk)
     end
 
-    def detect_faces
-      detect_objects(:faces)
+    # print all the clips
+    def print_clips(fname, &blk)
+      write_images(constitute_clips, fname, &blk)
     end
 
-    def detected_objects
-      @objects
+    def print_best_clip(fname, &blk)
+      write_images(constitute_best_clip, fname, &blk)
     end
 
-    def write(base_out_fname, &blk)
-      klass = self.class
+    # convenience method
+    def clip_and_print(obj_type, filename, *args, &blk)
+      clip(obj_type, *args, &blk)
 
-      if @objects.empty?        
-        img_objects = Array(image_object)
-      else
-        img_objects = @objects.map{|o| constitute_from_cv(o, image_object)}
-      end
+      print_clips(filename)
+    end
 
-      img_objects.each_with_index do |image_out, idx|
-        if block_given?
-          h = AttHash.new
-          yield h
+    # convenience method
+    def clip_and_print_best(obj_type, filename, *args, &blk)
+      clip(obj_type, *args, &blk)
 
-          # transform the image
-          image_out = h.inject(image_out) do |img, (foo, args)|
-            klass.send(foo, img, *args)
-          end
-        end
+      print_best_clip(filename)
+    end
 
-        if idx == 0
-          out_fname = base_out_fname
-        else
-          out_fname = base_out_fname.sub(/\.(?=\w+$)/, "-#{idx}.")
-        end
 
-        klass.output(image_out, out_fname)
-      end        
+    ### META STUFF
+
+    CLIPPER_REGEX = /^(clip_and_print(?:_best)?|clip)_(\w+)$/
+    def method_missing(foo, *args, &blk)
+      f = foo.to_s
+      # e.g. clip_faces
+      if f =~ CLIPPER_REGEX
+        self.send $1, $2, *args, &blk
+      else
+        super
+      end
     end
 
+    def respond_to?(foo, include_private=false)
+      return foo.to_s =~ CLIPPER_REGEX ? true : super(foo, include_private)
+    end
 
 
 
 
     private
 
+    def best_clip
+      @clips.best
+    end
 
-    # defer loading until it is needed
-    def image_object
-      @magick_image ||= load_magick_image(@filename)
+    def constitute_from_cv(cv, img)
+      Manipulator.constitute(img, cv.x, cv.y, cv.width, cv.height)
     end
 
-    def cv_object
-      @cv_image ||= load_cv_image(@filename)
+    def constitute(objects)
+      objs = Array(objects)
+      objs.map{|o| constitute_from_cv(o, magick_image)}
     end
 
+    # just a helper
+    def constitute_clips
+      constitute(@clips)
+    end
 
+    def constitute_best_clip
+      constitute(best_clip)
+    end
 
-    def constitute_from_cv(c, img)
-      pixels = img.dispatch(c.x, c.y, c.width, c.height, "RGB")
+    def cv_image
+      @_cv_image ||= Detector.load_cv(@filename)
+    end
 
-      return Magick::Image.constitute(c.width, c.height, "RGB", pixels)
+    def detect_and_collect(cv, obj_type)
+      Detector.detect_objects(cv, obj_type)
+    end
+   
+    # defer loading until it is needed
+    def magick_image
+      @_magick_image ||= Manipulator.load_magick(@filename)
     end
 
 
-    def load_magick_image(fname)
-       Magick::Image::read(fname).first
-    end
+    # returns a manipulated Magick file
+    def transform_image(obj, &blk)
+      transformed_obj = obj
+      if block_given?
+        method_queue = AttHash.new
+        yield method_queue
 
+        # transform the image
+        transformed_obj = method_queue.inject(transformed_obj) do |img, (foo, args)|
+          Manipulator.send(foo, img, *args)
+        end
+      end
 
-    def load_cv_image(fname)
-      IplImage::load(fname)
+      return transformed_obj
     end
 
+    def write_images(magick_objects, base_out_fname, &blk)    
 
-    # Image manipulation methods at the class level
-    # no reason for them to be instance methods
-    class << self 
-      def bw(img, num_colors = 128)
-        img.quantize(num_colors, Magick::GRAYColorspace)
-      end
+      arr = Array(magick_objects)
 
-      def resize_to_fit(img, w, h = nil)
-        h ||= w
+      arr.each_with_index do |obj, idx|
+        output_img = transform_image(obj, &blk)
+        # generate a numbered filename if there are more than one
+        output_fname = arr.count == 1 ? base_out_fname : base_out_fname.sub(/\.(?=\w+$)/, "-#{idx}.")
 
-        img.resize_to_fit(w, h)
+        write_image(output_img, output_fname)
       end
+    end
 
-      def output(img, out_fname)
-        img.write(out_fname)
-      end
+
+    # img is expected to be a Magick Object
+    def write_image(img, out_fname)
+      img.write(out_fname)
     end
 
+
+
   end
 end

data/lib/yearbook/manipulator.rb

@@ -0,0 +1,33 @@
+require 'rmagick'
+
+module Yearbook
+  module Manipulator
+
+    class << self
+      def bw(img, num_colors = 128)
+        img.quantize(num_colors, Magick::GRAYColorspace)
+      end
+
+
+      def constitute(img, *args)
+        x,y,w,h = args[0..3]
+        pixels = img.dispatch(x, y, w, h, "RGB")
+
+        Magick::Image.constitute(w, h, "RGB", pixels)
+      end
+
+      def resize_to_fit(img, w, h = nil)
+        h ||= w
+
+        img.resize_to_fit(w, h)
+      end
+
+
+      def load_magick(fname)
+        Magick::Image::read(fname).first
+      end
+
+
+    end
+  end
+end

data/spec/yearbook_spec.rb

@@ -21,39 +21,126 @@ module Yearbook
         end
       end
 
-      describe '#detect_faces' do
-        it 'should return an Array' do 
-          expect( @image.detect_faces ).to be_an Array
+      context 'clipping' do
+        before(:each) do
+          @image.clip_faces
+        end
+
+        it 'should be #clipped?' do 
+          expect(@image).to be_clipped
+        end
+
+        describe '@clips' do
+          it 'should return an Detection::Collection' do 
+            expect( @image.clips ).to be_a Yearbook::Detection::Collection
+          end
         end
       end
 
-      describe '#write' do
-        it 'should write to disk' do 
-          @image.write(@tempfile.path)
-          expect(@tempfile.size > 10000).to be_true
+      describe 'printing' do 
+        describe '#print' do
+          it 'should write the same file to disk' do 
+            @image.print(@tempfile.path)
+            expect(@tempfile.size > 10000).to be_true
+          end
         end
 
-        context 'after faces have been detected' do 
+        describe '#print_clips' do 
+          context 'after faces have been clipped' do 
+            before do 
+              @image.clip_faces
+            end
+
+            it 'should print each object to disk' do 
+              temp_path = @tempfile.path
+              @image.print_clips(temp_path)
+              @image.clips.each_with_index do |idx|
+                clip_path = temp_path.sub(/\.(?=\w+$)/, "-#{idx}.")
+                expect(File.exists?(clip_path)).to be_true
+              end                          
+            end
+          end
+        end
+
+        describe '#print_best_clip' do
           before do 
-            @image.detect_faces
+            @image.clip_faces
+            @image.print_best_clip(@tempfile.path)
+          end
+
+          it 'should print the one face' do 
+            expect(File.exists?@tempfile.path).to be_true
           end
 
-          it 'should write each object to disk' do 
-            last_num = @image.detected_objects.count - 1
-            path = @tempfile.path
-            last_path = path.sub(/\.(?=\w+$)/, "-#{last_num}.")
+          it 'that face should be the biggest face' do 
+            best_face = @image.send(:best_clip)
+
+            # icky method, requires using best_clip private method
+            # AND knowing default Detection::Collection :best sorting
 
-            @image.write(path)
-            expect(File.exists?(last_path)).to be_true
+            pixel_count = best_face.width * best_face.height
+            magick_image = Manipulator.load_magick(@tempfile.path)
+
+            expect(pixel_count).to eq magick_image.columns * magick_image.rows
+          end
+        end
+
+        context 'meta-conveniences' do 
+          it 'should have #clip_and_print_faces' do 
+            pending 'better path'
+            @image.clip_and_print_faces(@tempfile.path)
+          end
+
+          it 'should have #clip_and_print_best_face' do 
+            # note how tolerant it is of singular things
+            @image.clip_and_print_best_face(@tempfile.path)
+            best_face = @image.send(:best_clip)
+
+            # redux test
+            # icky method, requires using best_clip private method
+            # AND knowing default Detection::Collection :best sorting
+
+            pixel_count = best_face.width * best_face.height
+            magick_image = Manipulator.load_magick(@tempfile.path)
+
+
+binding.pry
+            expect(pixel_count).to eq magick_image.columns * magick_image.rows
           end
 
         end
       end
+      
+      context 'cropping' do 
+        it 'should allow close cropping'
+        it 'should take in percentages and weights'
+        # crop_to_object -10, -20
+      end
 
 
+        it 'should' do 
+          pending 'what'
+          @image.clipped? # to eq true
+          @image.clips # to be an array
+          @image.clips # to eq CV thingy
 
-    end
+#           # API:
+#           img = @image.new(@fname) 
+#           img.clip_face 
+#           img.write do |f|
+# # etc          do |f|
+#             f.clip_face  # -d face
+#             f.bw  # --bw
+#             f.resize_to_fill(100, 200)  # --fill 100,200
+#             f.write(whatev)
+#           end
 
+# yearbook photo.jpg face.jpg --clip face 
+
+        end
 
+
+
+    end
   end
 end

data/yearbook.gemspec

@@ -5,13 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "yearbook"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["dannguyen"]
-  s.date = "2013-11-06"
+  s.date = "2013-11-09"
   s.description = "Easy face-cropping"
   s.email = "dansonguyen@gmail.com"
+  s.executables = ["yearbook", "yearbook"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -25,6 +26,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/yearbook",
     "data/classifiers/eye-left-ojoI.xml",
     "data/classifiers/frontalEyes35x16.xml",
     "data/classifiers/haarcascade_frontalface_alt.xml",
@@ -34,7 +36,13 @@ Gem::Specification.new do |s|
     "lib/yearbook.rb",
     "lib/yearbook/att_hash.rb",
     "lib/yearbook/classifier.rb",
+    "lib/yearbook/cli.rb",
+    "lib/yearbook/detected_object.rb",
+    "lib/yearbook/detection.rb",
+    "lib/yearbook/detection/collection.rb",
+    "lib/yearbook/detector.rb",
     "lib/yearbook/image.rb",
+    "lib/yearbook/manipulator.rb",
     "spec/spec_helper.rb",
     "spec/yearbook_spec.rb",
     "yearbook.gemspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yearbook
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -157,7 +157,8 @@ dependencies:
         version: '0'
 description: Easy face-cropping
 email: dansonguyen@gmail.com
-executables: []
+executables:
+- yearbook
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -171,6 +172,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/yearbook
 - data/classifiers/eye-left-ojoI.xml
 - data/classifiers/frontalEyes35x16.xml
 - data/classifiers/haarcascade_frontalface_alt.xml
@@ -180,7 +182,13 @@ files:
 - lib/yearbook.rb
 - lib/yearbook/att_hash.rb
 - lib/yearbook/classifier.rb
+- lib/yearbook/cli.rb
+- lib/yearbook/detected_object.rb
+- lib/yearbook/detection.rb
+- lib/yearbook/detection/collection.rb
+- lib/yearbook/detector.rb
 - lib/yearbook/image.rb
+- lib/yearbook/manipulator.rb
 - spec/spec_helper.rb
 - spec/yearbook_spec.rb
 - yearbook.gemspec
@@ -199,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1267896751848541700
+      hash: 277460540779661417
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: