pnm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0626fcd5c88b2477eb1f76891857c83fb10d881
-  data.tar.gz: 29724fe5ca19969bb9bf66358272222189b17f33
+  metadata.gz: d185b233565cd87cea47d7a47fa8cd53cbd3120d
+  data.tar.gz: 65754714716d6b399cc8950e0ff90584cb42485a
 SHA512:
-  metadata.gz: 9e1f19e832e56b253d9db10794d4b414fc0211222c8e24ac572ffa93399e505bab04648b51ad1598916959480e2769fbac6f74253557f8a2a2ec81fca06aab8f
-  data.tar.gz: de73725df2c7703abd73e105ea770c4efe89d5db7caa01da45a747335a3d819003a946a8aaa31aa08869e0a8a6662e578cd23227d31daab00eabc686ac86e0ef
+  metadata.gz: 0737d6700d5ce343d0e326006213640eebe097181a47e3d99a70610a4f4aed95765a2fc1ccbee7b767177a9279224ef5814ee4fd53891a9de9b1eb0b9ca8a131
+  data.tar.gz: 2633bcdac0cf6fae08e3c36a9a81a6af985712273a9dc5361824794713c778300f12fa5ebee86eff5a34a7bf8bc4f38b4287f4e97887f3ca5685ea447c4d607f

data/README.md

@@ -13,50 +13,62 @@ Examples
 
 Create a PGM grayscale image from a two-dimensional array of gray values:
 
-    require 'pnm'
+``` ruby
+require 'pnm'
 
-    # pixel data
-    pixels = [[ 0, 10, 20],
-              [10, 20, 30]]
+# pixel data
+pixels = [[ 0, 10, 20],
+          [10, 20, 30]]
 
-    # optional settings
-    options = {:maxgray => 30, :comment => 'Test Image'}
+# optional settings
+options = {:maxgray => 30, :comment => 'Test Image'}
 
-    # create the image object
-    image = PNM::Image.new(:pgm, pixels, options)
+# create the image object
+image = PNM::Image.new(pixels, options)
 
-    # retrieve some image properties
-    image.info    # => "PGM 3x2 Grayscale"
-    image.width   # => 3
-    image.height  # => 2
+# retrieve some image properties
+image.info    # => "PGM 3x2 Grayscale"
+image.width   # => 3
+image.height  # => 2
+```
 
 See PNM::Image.new for a more detailed description of pixel data formats
 and available options.
 
 Write an image to a file:
 
-    image.write('test.pgm')
+``` ruby
+image.write('test.pgm')
 
-    # use ASCII or "plain" format (default is binary)
-    image.write('test.pgm', :ascii)
+# use ASCII or "plain" format (default is binary)
+image.write('test.pgm', :ascii)
 
-    # write to an I/O stream
-    File.open('test.pgm', 'w') {|f| image.write(f) }
+# write to an I/O stream
+File.open('test.pgm', 'w') {|f| image.write(f) }
+```
 
 Read an image from a file (returns a PNM::Image object):
 
-    image = PNM.read('test.pgm')
-    image.comment  # => "Test Image"
-    image.maxgray  # => 30
-    image.pixels   # => [[0, 10, 20], [10, 20, 30]]
+``` ruby
+image = PNM.read('test.pgm')
+image.comment  # => "Test Image"
+image.maxgray  # => 30
+image.pixels   # => [[0, 10, 20], [10, 20, 30]]
+```
 
+Force an image type:
+
+``` ruby
+image = PNM::Image.new([[0, 1],[1, 0]], :type => :ppm)
+image.info  # => "PPM 2x2 Color"
+```
 
 Installation
 ------------
 
 To install PNM, you can either
 
-- use `gem install pnm`, or
+- use `gem install pnm` to install from RubyGems.org,
 
 - clone or download the repository and use
   `rake build` and `[sudo] gem install pnm`.
@@ -66,8 +78,12 @@ Requirements
 
 - No additional Ruby gems or native libraries are needed.
 
-- PNM has been tested with Ruby 1.9.3 and Ruby 2.0.0
-  on Linux and on Windows.
+- PNM has been tested with
+
+  - Ruby 2.0.0 on Linux and on Windows,
+  - Ruby 1.9.3,
+  - JRuby 1.7.8,
+  - Rubinius 2.2.1.
 
 Documentation
 -------------

data/benchmark/bm_converter.rb

@@ -5,7 +5,6 @@
 
 require 'benchmark'
 require_relative '../lib/pnm'
-require_relative '../lib/pnm/converter'
 
 class ConverterBenchmark
 

data/lib/pnm.rb

@@ -29,7 +29,7 @@ require_relative 'pnm/converter'
 #     options = {:maxgray => 30, :comment => 'Test Image'}
 #
 #     # create the image object
-#     image = PNM::Image.new(:pgm, pixels, options)
+#     image = PNM::Image.new(pixels, options)
 #
 #     # retrieve some image properties
 #     image.info    # => "PGM 3x2 Grayscale"
@@ -56,6 +56,11 @@ require_relative 'pnm/converter'
 #     image.maxgray  # => 30
 #     image.pixels   # => [[0, 10, 20], [10, 20, 30]]
 #
+# Force an image type:
+#
+#     image = PNM::Image.new([[0, 1],[1, 0]], :type => :ppm)
+#     image.info  # => "PPM 2x2 Color"
+#
 # == See also
 #
 # Further information on the PNM library is available on the
@@ -139,10 +144,10 @@ module PNM
                Converter.binary2array(type, width, height, content[:data])
              end
 
-    options = {:maxgray => maxgray}
+    options = {:type => type, :maxgray => maxgray}
     options[:comment] = content[:comments].join("\n")  if content[:comments]
 
-    Image.new(type, pixels, options)
+    Image.new(pixels, options)
   end
 
   def self.magic_number  # :nodoc:

data/lib/pnm/image.rb

@@ -12,7 +12,8 @@ module PNM
     # The height of the image in pixels.
     attr_reader :height
 
-    # The maximum gray or color value. See ::new for details.
+    # The maximum gray or color value (for PBM always set to 1).
+    # See ::new for details.
     attr_reader :maxgray
 
     # The pixel data, given as a two-dimensional array.
@@ -25,7 +26,6 @@ module PNM
     # Creates an image from a two-dimensional array of bilevel,
     # gray, or RGB values.
     #
-    # +type+::    The type of the image (+:pbm+, +:pgm+, or +:ppm+).
     # +pixels+::  The pixel data, given as a two-dimensional array of
     #
     #             * for PBM: bilevel values (0 or 1),
@@ -33,26 +33,37 @@ module PNM
     #             * for PPM: an array of 3 values between 0 and +maxgray+,
     #               corresponding to red, green, and blue (RGB).
     #
-    #             PPM also accepts an array of gray values.
+    #             PPM also accepts an array of bilevel or gray values.
     #
     #             A value of 0 means that the color is turned off.
     #
     # Optional settings that can be specified in the +options+ hash:
     #
+    # +type+::    The type of the image (+:pbm+, +:pgm+, or +:ppm+).
+    #             By default, the type is guessed from the provided
+    #             pixel data, unless this option is used.
     # +maxgray+:: The maximum gray or color value.
     #             For PGM and PPM, +maxgray+ must be less or equal 255
-    #             (the default value). For PBM, this setting is ignored
-    #             and +maxgray+ is always set to 1.
+    #             (the default value).
+    #             For PBM pixel data, setting +maxgray+ implies a conversion
+    #             to +:pgm+. If +type+ is explicitly set to +:pbm+,
+    #             the +maxgray+ setting is disregarded.
     # +comment+:: A multiline comment string (default: empty string).
-    def initialize(type, pixels, options = {})
-      @type    = type
+    def initialize(pixels, options = {})
+      @type    = options[:type]
       @width   = pixels.first.size
       @height  = pixels.size
-      @maxgray = options[:maxgray] || 255
+      @maxgray = options[:maxgray]
       @comment = (options[:comment] || '').chomp
       @pixels  = pixels
 
-      @maxgray = 1  if type == :pbm
+      @type ||= detect_type(@pixels, @maxgray)
+
+      if @type == :pbm
+        @maxgray = 1
+      else
+        @maxgray ||= 255
+      end
 
       if type == :ppm && !pixels.first.first.kind_of?(Array)
         @pixels = pixels.map {|row| row.map {|pixel| gray_to_rgb(pixel) } }
@@ -99,6 +110,16 @@ module PNM
       end
     end
 
+    def detect_type(pixels, maxgray)  # :nodoc:
+      if pixels.first.first.kind_of?(Array)
+        :ppm
+      elsif pixels.flatten.max <= 1
+        maxgray ? :pgm : :pbm
+      else
+        :pgm
+      end
+    end
+
     def header(encoding)  # :nodoc:
       header =  "#{PNM.magic_number[type][encoding]}\n"
       if comment

data/lib/pnm/version.rb

@@ -1,4 +1,4 @@
 module PNM
-  VERSION  = '0.1.0'       # :nodoc:
-  DATE     = '2013-10-26'  # :nodoc:
+  VERSION  = '0.2.0'       # :nodoc:
+  DATE     = '2013-12-01'  # :nodoc:
 end

data/test/test_image.rb

@@ -20,7 +20,7 @@ describe PNM::Image do
               [0,0,1,0,0],
               [0,0,0,0,0]]
     comment = 'Bilevel'
-    @bilevel = PNM::Image.new(:pbm, pixels, {:comment => comment})
+    @bilevel = PNM::Image.new(pixels, {:comment => comment})
 
     pixels = [[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
               [0,1,1,1,0,1,1,1,1,0,1,1,1,1,1,0],
@@ -28,25 +28,77 @@ describe PNM::Image do
               [0,0,1,0,0,1,0,0,1,0,1,0,1,0,1,0],
               [0,0,1,0,0,1,1,1,1,0,1,0,1,0,1,0],
               [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]
-    @bilevel_2 = PNM::Image.new(:pbm, pixels)
+    @bilevel_2 = PNM::Image.new(pixels)
 
     pixels = [[  0, 50,100,150],
               [ 50,100,150,200],
               [100,150,200,250]]
     comment = "Grayscale\n(with multiline comment)"
-    @grayscale = PNM::Image.new(:pgm, pixels, {:maxgray => 250, :comment => comment})
+    @grayscale = PNM::Image.new(pixels, {:maxgray => 250, :comment => comment})
 
     pixels = [[65,66], [13,10], [65,66]]
-    @grayscale_crlf = PNM::Image.new(:pgm, pixels)
+    @grayscale_crlf = PNM::Image.new(pixels)
 
     pixels = [[[0,6,0], [1,5,1], [2,4,2], [3,3,4], [4,2,6]],
               [[1,5,2], [2,4,2], [3,3,2], [4,2,2], [5,1,2]],
               [[2,4,6], [3,3,4], [4,2,2], [5,1,1], [6,0,0]]]
-    @color = PNM::Image.new(:ppm, pixels, {:maxgray => 6})
+    @color = PNM::Image.new(pixels, {:maxgray => 6})
+  end
+
+  it 'sets maxgray to 1 for bilevel images' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]])
+    image.type.must_equal :pbm
+    image.maxgray.must_equal 1
+  end
+
+  it 'sets maxgray by default to 255 for grayscale images' do
+    image = PNM::Image.new([[0,10,20], [10,20,30]])
+    image.type.must_equal :pgm
+    image.maxgray.must_equal 255
+  end
+
+  it 'sets maxgray by default to 255 for color images' do
+    image = PNM::Image.new([[[0,0,0], [10,10,10]], [[10,10,10], [20,20,20]]])
+    image.type.must_equal :ppm
+    image.maxgray.must_equal 255
+  end
+
+  it 'ignores maxgray for bilevel images and sets it to 1' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:type => :pbm, :maxgray => 255})
+    image.type.must_equal :pbm
+    image.maxgray.must_equal 1
+  end
+
+  it 'can create a grayscale image from bilevel values (using type)' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:type => :pgm})
+    image.type.must_equal :pgm
+    image.pixels.must_equal [[0,1,0], [1,0,1]]
+    image.maxgray.must_equal 255
+  end
+
+  it 'can create a grayscale image from bilevel values (using maxgray)' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:maxgray => 1})
+    image.type.must_equal :pgm
+    image.pixels.must_equal [[0,1,0], [1,0,1]]
+    image.maxgray.must_equal 1
+  end
+
+  it 'can create a color image from bilevel values' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:type => :ppm})
+    image.info.must_match %r{^PPM 3x2 Color}
+    image.pixels.must_equal [[[0,0,0], [1,1,1], [0,0,0]], [[1,1,1], [0,0,0], [1,1,1]]]
+    image.maxgray.must_equal 255
+  end
+
+  it 'can create a color image from bilevel values with a given maxgray' do
+    image = PNM::Image.new([[0,1,0], [1,0,1]], {:type => :ppm, :maxgray => 2})
+    image.info.must_match %r{^PPM 3x2 Color}
+    image.pixels.must_equal [[[0,0,0], [1,1,1], [0,0,0]], [[1,1,1], [0,0,0], [1,1,1]]]
+    image.maxgray.must_equal 2
   end
 
   it 'can create a color image from gray values' do
-    image = PNM::Image.new(:ppm, [[0,3,6], [3,6,9]])
+    image = PNM::Image.new([[0,3,6], [3,6,9]], {:type => :ppm})
     image.info.must_match %r{^PPM 3x2 Color}
     image.pixels.must_equal [[[0,0,0], [3,3,3], [6,6,6]], [[3,3,3], [6,6,6], [9,9,9]]]
   end
@@ -105,7 +157,7 @@ describe PNM::Image do
     File.delete(@temp_path)
   end
 
-  it 'can write binary data containing CRLF from an I/O stream' do
+  it 'can write binary data containing CRLF to an I/O stream' do
     File.open(@temp_path, 'w') {|f| @grayscale_crlf.write(f, :binary) }
     File.binread(@temp_path).must_equal File.binread("#{@srcpath}/grayscale_binary_crlf.pgm")
     File.delete(@temp_path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-26 00:00:00.000000000 Z
+date: 2013-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: PNM - create/read/write PNM image files (PBM, PGM, PPM)