magro 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e24a0d3e82248b27f8a652e84ebe382363234a082732af2b1c18a55ea0dc6c3
-  data.tar.gz: dc3bc91550338e59455d2ea51effcaf6934b0970c7169434a2cce7422c852252
+  metadata.gz: 50da8b3b6adbd0f21ad6ae09373a4659be55806775a8c136f3d432616868b0f6
+  data.tar.gz: 860678b90cd8010f6968cf91b94e7572f98d4124aa310314aff41a4dc5861d03
 SHA512:
-  metadata.gz: 000e7447d4f24a0dd6c97610c5c057ee96feb6eb0698a4e3564e7cec29ce6103a1ac3479f12a90fd1d1436ea89329418097197ad346879cc00018cca25e25aa0
-  data.tar.gz: f8a09aad3d5fcadc92e753a453213f8c33e66fbde0522a263afeb02b7a3ceaaf3245c6801f9d61bde41fe7015070391bd3cba8298dc2a1ca275e4ed4e110c60b
+  metadata.gz: 43c79eac7ae51192d1a24d3fa17492d00507a2b6092ab10b62c5fdba83d24f589ff8fd7655d1bc0ea15746f4512e0c02903748d0be12355076c6953661461c85
+  data.tar.gz: 75e279fd89956ad161f1e5a188f3ffa272d1f881f350823d4de33abcca9d71bc6120e097d21a32ffb2e25f9cd7497db7cc375c06c755027880581d67b522f20e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.0
+- Add [filter module](https://yoshoku.github.io/magro/doc/Magro/Filter.html) consists of image filtering methods.
+- Change to use round instead of ceil in [quantization of resize method](https://github.com/yoshoku/magro/commit/1b3308ddfb98a650889483af3cd2045aaf6b8837) when given integer image.
+
 # 0.2.0
 - Add [transform module](https://yoshoku.github.io/magro/doc/Magro/Transform.html) and resize method.
 - Fix some configulation files.

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/yoshoku/magro.svg?branch=master)](https://travis-ci.org/yoshoku/magro)
 [![Gem Version](https://badge.fury.io/rb/magro.svg)](https://badge.fury.io/rb/magro)
 [![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-liblinear/blob/master/LICENSE.txt)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://yoshoku.github.io/magro/doc/)
+[![Documentation](http://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/magro/doc/)
 
 Magro is an image processing library in Ruby.
 Magro uses [Numo::NArray](https://github.com/ruby-numo/numo-narray) arrays as image objects.

data/lib/magro.rb

@@ -5,5 +5,6 @@ require 'numo/narray'
 require 'magro/version'
 require 'magro/magro'
 
+require 'magro/filter'
 require 'magro/io'
 require 'magro/transform'

data/lib/magro/filter.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Magro
+  # Filter module provides functions for image filtering.
+  module Filter
+    module_function
+
+    # Applies box filter to image.
+    # This method performs zero padding as a preprocessing.
+    #
+    # @example
+    #   image = Magro::IO.imread('foo.png')
+    #   kernel = Numo::DFloat[
+    #     [1, 1, 1],
+    #     [1, 1, 1],
+    #     [1, 1, 1]
+    #   ]
+    #   blured_image = Magro::Filter.filter2d(image, kernel)
+    #   Magro::IO.imsave('bar.png', blured_image)
+    #
+    # @param image [Numo::UInt8] (shape: [height, width, n_channels]) Input image to be filtered.
+    # @param kernel [Numo::DFloat] (shape: [kernel_height, kernel_width]) Box filter.
+    # @param scale [Float/Nil] Scale parameter for box filter. If nil is given, the box filter is normalized with sum of filter values.
+    # @param offset [Integer] Offset value of filtered image.
+    # @raise [ArgumentError] This error is raised when class of input image is not Numo::NArray.
+    # @return [Numo::UInt8] (shape: [height, width, n_channels]) Filtered image.
+    def filter2d(image, kernel, scale: nil, offset: 0)
+      raise ArgumentError, 'Expect class of image to be Numo::NArray.' unless image.is_a?(Numo::NArray)
+      filter_h, filter_w = kernel.shape
+      padded = zero_padding(image, filter_h, filter_w)
+      n_channels = image.shape[2]
+      if n_channels.nil?
+        filter1ch(padded, kernel, scale, offset)
+      else
+        image.class.zeros(*image.shape).tap do |filtered|
+          n_channels.times do |c|
+            filtered[true, true, c] = filter1ch(padded[true, true, c], kernel, scale, offset)
+          end
+        end
+      end
+    end
+
+    # Convolve two 2-dimensional arrays.
+    #
+    # @param arr1 [Numo::NArray] (shape: [row1, col1]) First input array.
+    # @param arr2 [Numo::NArray] (shape: [row2, col2]) Second input array.
+    # @raise [ArgumentError] This error is raised when class of input array is not Numo::NArray.
+    # @return [Numo::NArray] (shape: [row1 - row2 + 1, col1 - col2 + 1]) Convolution of arr1 with arr2.
+    def convolve2d(arr1, arr2)
+      raise ArgumentError, 'Expect class of first input array to be Numo::NArray.' unless arr1.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect class of second input array to be Numo::NArray.' unless arr2.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect first input array to be 2-dimensional array.' unless arr1.ndim == 2
+      raise ArgumentError, 'Expect second input array to be 2-dimensional array.' unless arr2.ndim == 2
+      row1, col1 = arr1.shape
+      row2, col2 = arr2.shape
+      # FIXME: lib/numo/narray/extra.rb:1098: warning: Using the last argument as keyword parameters is deprecated
+      # convolved = im2col(arr1, row2, col2).dot(arr2.flatten)
+      convolved = arr2.flatten.dot(im2col(arr1, row2, col2).transpose)
+      convolved.reshape(row1 - row2 + 1, col1 - col2 + 1)
+    end
+
+    # private
+
+    def zero_padding(image, filter_h, filter_w)
+      image_h, image_w, n_channels = image.shape
+      pad_h = filter_h / 2
+      pad_w = filter_w / 2
+      out_h = image_h + pad_h * 2
+      out_w = image_w + pad_w * 2
+      if n_channels.nil?
+        image.class.zeros(out_h, out_w).tap do |padded|
+          padded[pad_h...(pad_h + image_h), pad_w...(pad_w + image_w)] = image
+        end
+      else
+        image.class.zeros(out_h, out_w, n_channels).tap do |padded|
+          n_channels.times do |c|
+            padded[pad_h...(pad_h + image_h), pad_w...(pad_w + image_w), c] = image[true, true, c]
+          end
+        end
+      end
+    end
+
+    def filter1ch(image, kernel, scale, offset)
+      scale ||= kernel.sum
+      kernel *= scale.zero? ? 1.0 : 1.fdiv(scale)
+      filtered = convolve2d(image, kernel)
+      filtered = (filtered + offset).round.clip(image.class::MIN, image.class::MAX) if integer_narray?(image)
+      filtered = image.class.cast(filtered) unless filtered.is_a?(image.class)
+      filtered
+    end
+
+    def im2col(image, filter_h, filter_w)
+      height, width = image.shape
+      rows = height - filter_h + 1
+      cols = width - filter_w + 1
+      mat = image.class.zeros(filter_h, filter_w, rows, cols)
+      filter_h.times do |y|
+        y_end = y + rows
+        filter_w.times do |x|
+          x_end = x + cols
+          mat[y, x, true, true] = image[y...y_end, x...x_end]
+        end
+      end
+      mat.transpose(2, 3, 0, 1).reshape(rows * cols, filter_h * filter_w)
+    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 :zero_padding, :filter1ch, :im2col, :integer_narray?
+  end
+end

data/lib/magro/transform.rb

@@ -58,7 +58,7 @@ module Magro
 
       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.ceil.clip(image.class::MIN, image.class::MAX) if integer_narray?(image)
+      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

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.2.0'
+  VERSION = '0.3.0'
 end

data/magro.gemspec

@@ -14,6 +14,11 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magro
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -49,6 +49,7 @@ files:
 - 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
@@ -56,7 +57,11 @@ files:
 homepage: https://github.com/yoshoku/magro
 licenses:
 - BSD-3-Clause
-metadata: {}
+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: