dzt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ebec393c326ec86c8abdb6f4ccc73c4c74398b8
+  data.tar.gz: 647bcbe70edcb2a8718a757cd12f2cbda0eac921
+SHA512:
+  metadata.gz: 8735da367c32b01f25ad064685ff460eeaaf874410a99c238932ec3e5a2264df35a6eff169f3057ec3bb1cfd7650a6929084faa68d3391bd111602c998ac6b9d
+  data.tar.gz: 65cdf93cb7fb7bd6a8926f9410456fbb38def9193ffb7832a7eeb1167fd61281dadf1873f0122b27c60c9cc2db121fc55ae99674f6e76e49cf090f44ec9254c3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (3/16/2014)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+Contributing
+============
+
+You're encouraged to contribute to this gem.
+
+* Fork this project.
+* Make changes, write tests.
+* Updated [CHANGELOG](CHANGELOG.md).
+* Make a pull request, bonus points for topic branches.
+

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014 Daniel Doubrovkine.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+DZT
+===
+
+[![Build Status](https://travis-ci.org/dblock/dzt.png)](https://travis-ci.org/dblock/dzt)
+
+Slice deep-zoom tiled images to be used with [OpenSeaDragon](http://openseadragon.github.io/) or [ARTiledImageView](https://github.com/dblock/ARTiledImageView).
+
+![](screenshots/goya.gif)
+
+## Usage
+
+```
+gem install dzt
+```
+
+#### Get Help
+
+```
+dzt help
+```
+
+#### Tile an Image
+
+```
+dzt slice image.jpg --output tiles
+```
+
+Creates a *tiles* folder with deep-zoom tiles.
+
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2014, Daniel Doubrovkine, [Artsy](http://artsy.github.io). Some tiling code inspired from [deep_zoom_slicer](https://github.com/meso-unimpressed/deep_zoom_slicer).
+
+This project is licensed under the [MIT License](LICENSE.md).

data/bin/dzt

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'dzt'
+
+include GLI::App
+
+program_desc 'Tile images into deep-zoom tiles'
+
+default_command :slice
+
+desc "Slice an image"
+command :slice do |c|
+  c.flag [:o, :output], desc: 'Output folder', default_value: File.join(Dir.pwd, "tiles")
+  c.action do |global_options, options, args|
+    if args.length < 1
+      raise 'You must specify an image file to slice.'
+    end
+    tiler = DZT::Tiler.new(
+      source: args[0],
+      destination: options[:output]
+    )
+    tiler.slice! do |path|
+      puts path
+    end
+  end
+end
+
+exit run(ARGV)

data/lib/dzt.rb

@@ -0,0 +1,3 @@
+require 'RMagick'
+require 'dzt/version'
+require 'dzt/tiler'

data/lib/dzt/tiler.rb

@@ -0,0 +1,126 @@
+# Deep Zoom module for generating Deep Zoom (DZI) tiles from a source image
+module DZT
+  class Tiler
+    # Defaults
+    DEFAULT_TILE_SIZE = 512
+    DEFAULT_TILE_OVERLAP = 0
+    DEFAULT_QUALITY = 75
+    DEFAULT_TILE_FORMAT = "jpg"
+
+    # Generates the DZI-formatted tiles and sets necessary metadata on this object.
+    #
+    # @param source Magick::Image, or filename of image to be used for tiling
+    # @param quality Image compression quality (default: 75)
+    # @param format Format for output tiles (default: "jpg")
+    # @param size Size, in pixels, for tile squares (default: 512)
+    # @param overlap Size, in pixels, of the overlap between tiles (default: 2)
+    # @param overwrite If true, overwrites existing tiles (default: false)
+    # @param destination: Full directory in which to output tiles.
+    #
+    def initialize(options)
+      @tile_source = options[:source]
+      raise "Missing options[:source]." unless @tile_source
+      @tile_source = Magick::Image.read(@tile_source)[0] if @tile_source.is_a?(String)
+      @tile_size = options[:size] || DEFAULT_TILE_SIZE
+      @tile_overlap = options[:overlap] || DEFAULT_TILE_OVERLAP
+      @tile_format  = options[:format] || DEFAULT_TILE_FORMAT
+      @max_tiled_height = @tile_source.rows
+      @max_tiled_width = @tile_source.columns
+      @tile_quality = options[:quality] || DEFAULT_QUALITY
+      @overwrite = options[:overwrite] || false
+      @destination = options[:destination] || File.join(Dir.pwd, "tiles")
+    end
+
+    ##
+    # Generates the DZI-formatted tiles and sets necessary metadata on this object.
+    # Uses a default tile size of 512 pixels, with a default overlap of 2 pixel.
+    ##
+    def slice!(&block)
+      if ! @overwrite && File.directory?(@destination) && ! Dir["@{@destination}/*"].empty?
+        raise "Output directory #{@destination} already exists!"
+        @overwrite ? Rails.logger.warn(msg) : raise(msg)
+      end
+
+      image = @tile_source.dup
+      orig_width, orig_height = image.columns, image.rows
+
+      # iterate over all levels (= zoom stages)
+      max_level(orig_width, orig_height).downto(0) do |level|
+        width, height = image.columns, image.rows
+
+        current_level_dir = File.join(@destination, level.to_s)
+        FileUtils.mkdir_p(current_level_dir)
+
+        if block_given?
+          yield current_level_dir
+        end
+
+        # iterate over columns
+        x, col_count = 0, 0
+        while x < width
+          # iterate over rows
+          y, row_count = 0, 0
+          while y < height
+            dest_path = File.join(current_level_dir, "#{col_count}_#{row_count}.#{@tile_format}")
+            tile_width, tile_height = tile_dimensions(x, y, @tile_size, @tile_overlap)
+
+            save_cropped_image(image, dest_path, x, y, tile_width, tile_height, @tile_quality)
+
+            y += (tile_height - (2 * @tile_overlap))
+            row_count += 1
+          end
+          x += (tile_width - (2 * @tile_overlap))
+          col_count += 1
+        end
+
+        image.resize!(0.5)
+      end
+
+      image.destroy!
+    end
+
+    protected
+
+    # Determines width and height for tiles, dependent of tile position.
+    # Center tiles have overlapping on each side.
+    # Borders have no overlapping on the border side and overlapping on all other sides.
+    # Corners have only overlapping on the right and lower border.
+    def tile_dimensions(x, y, tile_size, overlap)
+      overlapping_tile_size = tile_size + (2 * overlap)
+      border_tile_size      = tile_size + overlap
+
+      tile_width  = (x > 0) ? overlapping_tile_size : border_tile_size
+      tile_height = (y > 0) ? overlapping_tile_size : border_tile_size
+
+      return tile_width, tile_height
+    end
+
+    # Calculates how often an image with given dimension can
+    # be divided by two until 1x1 px are reached.
+    def max_level(width, height)
+      return (Math.log([width, height].max) / Math.log(2)).ceil
+    end
+
+    # Crops part of src image and writes it to dest path.
+    #
+    # Params: src: may be an Magick::Image object or a path to an image.
+    #         dest: path where cropped image should be stored.
+    #         x, y: offset from upper left corner of source image.
+    #         width, height: width and height of cropped image.
+    #         quality: compression level 0-100 (or 0.0-1.0), lower number means higher compression.
+    def save_cropped_image(src, dest, x, y, width, height, quality = 75)
+      if src.is_a? Magick::Image
+        img = src
+      else
+        img = Magick::Image::read(src).first
+      end
+
+      quality = quality * 100 if quality < 1
+
+      # The crop method retains the offset information in the cropped image.
+      # To reset the offset data, adding true as the last argument to crop.
+      cropped = img.crop(x, y, width, height, true)
+      cropped.write(dest) { @quality = quality }
+    end
+  end
+end

data/lib/dzt/version.rb

@@ -0,0 +1,3 @@
+module DZT
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: dzt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dblock@dblock.org
+executables:
+- dzt
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/dzt
+- lib/dzt/tiler.rb
+- lib/dzt/version.rb
+- lib/dzt.rb
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+homepage: http://github.com/dblock/dzt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Tile images for deep-zoom.
+test_files: []