Magro

Magro is an image processing library in Ruby. Magro uses Numo::NArray arrays as image objects.

Installation

Magro dependents libpng and libjpeg to provides functions loading image file. It is recommended that using libpng version 1.6 or later.

macOS:

$ brew install libpng libjpeg

Ubuntu (bionic):

$ sudo apt-get install libpng-dev libjpeg-dev

Add this line to your application's Gemfile:

gem 'magro'

And then execute:

$ bundle

Or install it yourself as:

$ gem install magro

Usage

> require 'magro'
=> true
> image = Magro::IO.imread('lena.png')
=> Numo::UInt8#shape=[512,512,3]
> grayscale = image.median(axis: 2)
=> Numo::UInt8#shape=[512,512]
> Magro::IO.imsave('lena_gray.png', grayscale)
=> true

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/magro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Magro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.