tily.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 689971c694082323bbab56cf08dfc2e3ef225329
+  data.tar.gz: 0c577325a87b38f3a19ef015c8d043371879df38
+SHA512:
+  metadata.gz: 3c4565fcdc74901586f014f5ad2cd62ca647361a9673559723463b49d4f48616ec1b2decfab909f62ee05ddda546d24afff0dc3a5859a3ba4ccfec050a551d5d
+  data.tar.gz: d6967f36285375f5384dcb3cca3a94459e4eb2bf025817eb1987e6602eb61e2eb3ae66f6781821cd1b91b770c4f970ba6827ef705064211d8e779fee71e5836a

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,4 @@
+tily.rb
+=======
+
+Map tile generator with ruby.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+spec = eval(File.read('tily-rb.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+RSpec::Core::RakeTask.new
+task :default => :spec

data/lib/tily.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+require 'rmagick'
+require 'FileUtils'
+require './tily/utils/tile_system'
+
+include Magick
+
+module Tily
+	class Tily
+		attr_accessor :raw_image
+		attr_accessor :output_path
+		attr_accessor :ts
+		attr_accessor :background_color
+
+		def initialize img_path, output_path, unit_size = 256, background_color = "grey"
+			@raw_image = ImageList.new img_path
+			@output_path = output_path
+			@ts = TileSystem.new unit_size
+			@ts.read_raw_dimension @raw_image.columns, @raw_image.rows
+			@background_color = background_color
+		end
+
+		def gen_tiles
+			norm_size = @ts.normalized_size
+			base_img = Image.new(norm_size, norm_size) { self.background_color = "grey" }
+			base_img = base_img.composite(@raw_image, GravityType::CenterGravity, CompositeOperator::CopyCompositeOp)
+
+			puts "Generating images..."
+
+			@ts.each_level do |level|
+				puts "Level #{level}:"
+
+				level_folder = "#{@output_path}/#{level}"
+				FileUtils.mkdir_p level_folder unless Dir.exists? level_folder
+
+				level_size = @ts.tile_size level
+				level_img  = base_img.resize level_size, level_size
+
+				@ts.each_tile_with_index(level) do |x, y, index|
+					tile_img = level_img.crop(@ts.tile_offset(x), @ts.tile_offset(y), @ts.unit_size, @ts.unit_size)
+					tile_img.write("#{level_folder}/#{@ts.quadkey(level, x, y)}.png")
+				end
+
+				puts "Done."
+			end
+
+			puts "Tiles generated to folder '#{@output_path}'..."
+		end
+
+		private
+		# Format a beautiful hint string
+		def processing_hint_str number, level
+			total = (@ts.tile_size(level) ** 2).to_s
+			now   = (number + 1).to_s.rjust(total.length, " ")
+			"#{now}/#{total}"
+		end
+	end
+end
+
+
+#img_path = "/Users/voidmain/Desktop/el-mundo.jpg"
+#target_path = "#{Dir.home()}/Desktop/el-mundo"
+#tily = Tily::Tily.new img_path, target_path
+#tily.gen_tiles

data/lib/tily/utils/tile_system.rb

@@ -0,0 +1,102 @@
+class Fixnum
+	def bin_str level
+		self.to_s(2).rjust(level, "0")
+	end
+end
+
+module Tily
+	# Implements a simple tile calculating system according to
+	# A dev guide named "Bing Maps Tile System".
+	# Link here: http://msdn.microsoft.com/en-us/library/bb259689.aspx
+	class TileSystem
+		attr_accessor :unit_size
+		attr_accessor :raw_width
+		attr_accessor :raw_height
+
+		# Initialize with customizable unit tile size
+		# Default value: 256
+		def initialize unit_size = 256 # defaults to 256
+			@unit_size = unit_size
+		end
+
+		# Read in raw dimension to be processed
+		def read_raw_dimension width, height
+			@raw_width = width
+			@raw_height = height
+		end
+
+		# Calculates level size of the raw dimensions
+		# Basically, it calculates level from width and
+		# height respectly, and return the bigger number
+		def max_level
+			[to_level(@raw_width), to_level(@raw_height)].max
+		end
+
+		# Returns the normalized number
+		# Sometimes, the image is not so well prepared in dimension
+		# so, we need to calculate the normalized size
+		def normalized_size
+			tile_size(max_level) * @unit_size
+		end
+
+		# Returns the number of tile as for rows/columns in a level
+		def tile_size level
+			2 ** level
+		end
+
+		# Returns the pixel offset in the image
+		def tile_offset index
+			@unit_size * index
+		end
+
+		# Calculates quadkey for tile (<x>, <y>) on level <level_number>
+		# The process is kind of complex, here's what it does:
+		# 1. Converts x, y to binary string
+		# 2. Interleave the bits of y and x coordinates
+		# 3. Interprate the result as a base-4 number (with leading zeros maintained)
+		def quadkey level, x, y
+			x_chars = x.bin_str(level).split ""
+			y_chars = y.bin_str(level).split ""
+
+			y_chars.zip(x_chars).flatten.join("").to_i(2).to_s(4).rjust(level, "0")
+		end
+
+		# Returns the list of possible levels
+		def each_level
+			(1..max_level).each do |level|
+				yield level if block_given?
+			end
+		end
+
+		# Builds the "x, y" pairs, and returns these pairs in block
+		def each_tile level
+			size = tile_size level
+			(0...size).each do |y|
+				(0...size).each do |x|
+					yield(x, y) if block_given?
+				end
+			end
+		end
+
+		# Builds the "x, y, index" pairs, and returns these pairs in block
+		def each_tile_with_index level
+			idx = 0
+			size = tile_size level
+			(0...size).each do |y|
+				(0...size).each do |x|
+					yield(x, y, idx) if block_given?
+										$stdout.flush
+					idx += 1
+				end
+			end
+		end
+
+		private
+		# Calculate level size from raw size with the following fomula:
+		#    level = ceil(log2(raw size / unit_size))
+		def to_level raw_size
+			Math.log2(1.0 * raw_size / @unit_size).ceil
+		end
+
+	end
+end

data/lib/tily/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+# require 'tily'
+require 'tily/utils/tile_system'

data/spec/utils/tile_system_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Tily::TileSystem do
+  before :each do
+    # Set unit_size to 256
+    @ts = Tily::TileSystem.new 256
+    @ts.read_raw_dimension 3824, 3904
+  end
+
+  it 'should create binary string filling 0s in the beginning' do
+    1.bin_str(3).should == "001"
+  end
+
+  it 'should wrap width to "256 * 2 ** level"' do
+    @ts.normalized_size.should == 4096
+  end
+
+  it 'should tell max level correctly' do
+    @ts.max_level.should == 4
+  end
+
+  it 'should calculate tile size correctly' do
+    @ts.tile_size(4).should == 2 ** 4
+  end
+
+  it 'should calculate tile offset correctly' do
+    @ts.tile_offset(2).should == 512
+  end
+
+  it 'should calculate quadkey correctly' do
+    @ts.quadkey(3, 3, 5).should == "213"
+  end
+
+  it 'should iterate through all levels' do
+    levels = []
+    @ts.each_level {|level| levels << level }
+    levels.should == [1, 2, 3, 4]
+  end
+
+  it 'should iterate through all tiles of a level' do
+    tiles = []
+    @ts.each_tile(3) {|x, y| tiles << [x, y]}
+    tiles.length.should == 64
+  end
+end

data/tily-rb.gemspec

@@ -0,0 +1,26 @@
+require './lib/tily/version'
+
+Gem::Specification.new do |s|
+  s.name = 'tily.rb'
+  s.version = Tily::VERSION
+  s.author = 'Peng Sun'
+  s.email = 'voidmain1313113@gmail.com'
+
+  s.description = 'A simple map tile generator that divides huge images into classifed levels, with small tile images.'
+  s.summary = 'A simple map tile generator that divides huge images into classifed levels, with small tile images.'
+  s.homepage = 'https://github.com/void-main/tily.rb'
+  s.license = 'Apache v2 License'
+
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = %w[lib]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = Dir['spec/**/*.rb']
+
+  s.add_dependency('rmagick', '>= 2.13.2')
+  
+  s.add_development_dependency 'rake',    '~> 0.9.0'
+  s.add_development_dependency 'rspec',   '~> 2.6.0'
+
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+  s.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'tily.rb', '--main', 'README.md']
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: tily.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peng Sun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: A simple map tile generator that divides huge images into classifed levels,
+  with small tile images.
+email: voidmain1313113@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/tily.rb
+- lib/tily/utils/tile_system.rb
+- lib/tily/version.rb
+- spec/spec_helper.rb
+- spec/utils/tile_system_spec.rb
+- tily-rb.gemspec
+homepage: https://github.com/void-main/tily.rb
+licenses:
+- Apache v2 License
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- tily.rb
+- --main
+- README.md
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A simple map tile generator that divides huge images into classifed levels,
+  with small tile images.
+test_files:
+- spec/spec_helper.rb
+- spec/utils/tile_system_spec.rb