magro 0.1.0 → 0.4.0

data/lib/magro/io.rb

@@ -9,11 +9,14 @@ module Magro
     # @param filename [String] Path to image file to be loaded.
     #   Currently, the following file formats are support:
     #   Portbale Network Graphics (*.png) and JPEG files (*.jpeg, *.jpg, *jpe).
+    # @raise [ArgumentError] This error is raised when filename is not String.
+    # @raise [IOError] This error is raised when failed to read image file.
+    # @raise [NoMemoryError] If memory allocation of image data fails, this error is raised.
     # @return [Numo::UInt8] (shape: [height, width, n_channels]) Loaded image.
     def imread(filename)
       raise ArgumentError, 'Expect class of filename to be String.' unless filename.is_a?(String)
-      return read_jpg(filename) if filename =~ /\.(jpeg|jpg|jpe)$/
-      return read_png(filename) if filename =~ /\.png$/
+      return read_jpg(filename) if filename.downcase =~ /\.(jpeg|jpg|jpe)$/
+      return read_png(filename) if filename.downcase =~ /\.png$/
     end
 
     # Saves an image to file.
@@ -22,12 +25,15 @@ module Magro
     #   Portbale Network Graphics (*.png) and JPEG files (*.jpeg, *.jpg, *jpe).
     # @param image [Numo::UInt8] (shape: [height, width, n_channels]) Image data to be saved.
     # @param quality [Integer] Quality parameter of jpeg image that takes a value between 0 to 100.
+    # @raise [ArgumentError] If filename is not String or image is not Numo::NArray, this error is raised.
+    # @raise [IOError] This error is raised when failed to read image file.
+    # @raise [NoMemoryError] If memory allocation of image data fails, this error is raised.
     # @return [Boolean] true if file save is successful.
     def imsave(filename, image, quality: nil)
       raise ArgumentError, 'Expect class of filename to be String.' unless filename.is_a?(String)
       raise ArgumentError, 'Expect class of image to be Numo::NArray.' unless image.is_a?(Numo::NArray)
 
-      if filename =~ /\.(jpeg|jpg|jpe)$/
+      if filename.downcase =~ /\.(jpeg|jpg|jpe)$/
         unless quality.nil?
           raise ArgumentError, 'Expect class of quality to be Numeric.' unless quality.is_a?(Numeric)
           raise ArgumentError, 'Range of quality value between 0 to 100.' unless quality.between?(0, 100)
@@ -35,7 +41,7 @@ module Magro
         return save_jpg(filename, image, quality)
       end
 
-      return save_png(filename, image) if filename =~ /\.png$/
+      return save_png(filename, image) if filename.downcase =~ /\.png$/
 
       false
     end

data/lib/magro/transform.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Magro
+  # Transform module provide functions of image transfom.
+  module Transform
+    module_function
+
+    # Resizes an image with bilinear interpolation method.
+    #
+    # @example
+    #   require 'numo/narray'
+    #   require 'magro'
+    #
+    #   image = Numo::UInt8.new(16, 16).seq
+    #   resized = Magro::Transform.resize(image, height: 64, width: 64)
+    #
+    # @param image [Numo::UInt8] (shape: [height, width, n_channels] or [height, width]) Image data to be saved.
+    # @param height [Integer] Requested height in pixels.
+    # @param width [Integer] Requested width in pixels.
+    # @return [Numo::UInt8] (shape: [height, width, n_channels] or [height, width]) Resized image data.
+    def resize(image, height:, width:)
+      n_channels = image.shape[2]
+
+      if n_channels.nil?
+        bilinear_resize(image, height, width)
+      else
+        resized = image.class.zeros(height, width, n_channels)
+        n_channels.times { |c| resized[true, true, c] = bilinear_resize(image[true, true, c], height, width) }
+        resized
+      end
+    end
+
+    # private
+
+    def bilinear_resize(image, new_height, new_width)
+      height, width = image.shape
+
+      y_ratio = height.fdiv(new_height)
+      x_ratio = width.fdiv(new_width)
+
+      y, x = Numo::Int32.new(new_height * new_width).seq.divmod(new_width)
+
+      y_p = Numo::Int32.cast((y_ratio * (y + 0.5) - 0.5).floor).clip(0, height - 1)
+      x_p = Numo::Int32.cast((x_ratio * (x + 0.5) - 0.5).floor).clip(0, width - 1)
+      y_n = Numo::Int32.cast((y_ratio * (y + 0.5) - 0.5).ceil).clip(0, height - 1)
+      x_n = Numo::Int32.cast((x_ratio * (x + 0.5) - 0.5).ceil).clip(0, width - 1)
+
+      flt = image.flatten
+      a = flt[y_p * width + x_p]
+      b = flt[y_p * width + x_n]
+      c = flt[y_n * width + x_p]
+      d = flt[y_n * width + x_n]
+
+      y_d = y_ratio * (y + 0.5) - 0.5
+      x_d = x_ratio * (x + 0.5) - 0.5
+      y_d = y_d.class.maximum(0, y_d - y_d.floor)
+      x_d = x_d.class.maximum(0, x_d - x_d.floor)
+
+      resized = a * (1 - x_d) * (1 - y_d) + b * x_d * (1 - y_d) + c * (1 - x_d) * y_d + d * x_d * y_d
+
+      resized = resized.round.clip(image.class::MIN, image.class::MAX) if integer_narray?(image)
+      resized = image.class.cast(resized) unless resized.is_a?(image.class)
+      resized.reshape(new_height, new_width)
+    end
+
+    INTEGER_NARRAY = %w[Numo::Int8 Numo::Int16 Numo::Int32 Numo::Int64
+                        Numo::UInt8 Numo::UInt16 Numo::UInt32 Numo::UInt64].freeze
+
+    private_constant :INTEGER_NARRAY
+
+    def integer_narray?(image)
+      INTEGER_NARRAY.include?(image.class.to_s)
+    end
+
+    private_class_method :bilinear_resize, :integer_narray?
+  end
+end

data/lib/magro/version.rb

@@ -3,5 +3,5 @@
 # Magro is an image processing library in Ruby.
 module Magro
   # The version of Magro you are using.
-  VERSION = '0.1.0'
+  VERSION = '0.4.0'
 end

data/magro.gemspec

@@ -8,12 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['yoshoku']
   spec.email         = ['yoshoku@outlook.com']
 
-  spec.summary       = 'Magro is an image processing library for Ruby.'
-  spec.description   = 'Magro is an image processing library for Ruby.'
+  spec.summary       = 'Magro is a minimal image processing library for Ruby.'
+  spec.description   = <<~MSG
+    Magro is a minimal image processing library for Ruby.
+    Magro uses Numo::NArray arrays as image objects and provides basic image processing functions.
+    Current supporting features are reading and writing JPEG and PNG images,
+    image resizing with bilinear interpolation method, and image filtering.
+  MSG
 
   spec.homepage      = 'https://github.com/yoshoku/magro'
   spec.license       = 'BSD-3-Clause'
 
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yoshoku/magro'
+  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/magro/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://yoshoku.github.io/magro/doc/'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
@@ -26,9 +36,4 @@ Gem::Specification.new do |spec|
   spec.extensions    = ['ext/magro/extconf.rb']
 
   spec.add_runtime_dependency 'numo-narray', '~> 0.9.1'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rake-compiler', '~> 1.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magro
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - yoshoku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-04 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -24,63 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-description: Magro is an image processing library for Ruby.
+description: |
+  Magro is a minimal image processing library for Ruby.
+  Magro uses Numo::NArray arrays as image objects and provides basic image processing functions.
+  Current supporting features are reading and writing JPEG and PNG images,
+  image resizing with bilinear interpolation method, and image filtering.
 email:
 - yoshoku@outlook.com
 executables: []
@@ -88,6 +36,7 @@ extensions:
 - ext/magro/extconf.rb
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -100,17 +49,25 @@ files:
 - bin/console
 - bin/setup
 - ext/magro/extconf.rb
+- ext/magro/imgrw.c
+- ext/magro/imgrw.h
 - ext/magro/magro.c
 - ext/magro/magro.h
 - lib/magro.rb
+- lib/magro/filter.rb
 - lib/magro/io.rb
+- lib/magro/transform.rb
 - lib/magro/version.rb
 - magro.gemspec
 homepage: https://github.com/yoshoku/magro
 licenses:
 - BSD-3-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/yoshoku/magro
+  source_code_uri: https://github.com/yoshoku/magro
+  changelog_uri: https://github.com/yoshoku/magro/blob/master/CHANGELOG.md
+  documentation_uri: https://yoshoku.github.io/magro/doc/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Magro is an image processing library for Ruby.
+summary: Magro is a minimal image processing library for Ruby.
 test_files: []