imagetiler 0.1.0

data/README.markdown

@@ -0,0 +1,65 @@
+# imagetiler -- A simple tool to tile images.
+
+imagetiler is a simple command-line and ruby image tiler with support for multiple zoom levels and different image formats.
+
+
+## How to use
+
+#### From the command line
+
+`ruby tile_image.rb -o OUTPUT_DIR -z ZOOM_LEVELS IMAGE_FILE`  
+
+For example
+
+`ruby tile_image.rb -o ./tiles -z 2..4 ./input_files/map.jpg`
+
+
+#### From ruby
+
+`require 'imagetiler'
+t = Tiler.new  
+t.make_tiles(image_source, opts)`
+
+`image_source` can be either a filename or an RMagick Image.
+
+You can set options two ways:  
+`t.zoom_levels = 2..4`  
+or  
+`t.get_tiles(image, :zoom_levels => 2..4)`
+
+Setting options in the get_tiles function sets them for that instance of Tiler.
+
+
+## Methods
+
+`make_tiles(image_source, opts)`  
+
+`calc_native_res_zoom` : Calculates the zoom level closest to native resolution. Returns a float for the zoom -- so, use zoom.round if you want the closest zoom level, for example
+
+
+## Output
+Tiles in the output folder with format  
+`#{output_dir}/#{prefix}_#{zoom_level}_#{tile_col}_#{tile_row}.#{image_format}`
+
+
+## Options
+
+`zoom_levels` : Zoom level 0 shows the entire image as one 256x256 tile. Subsequent zoom levels double both the horizontal and vertical sides. Default is 0..4  
+`output_dir` : Defaults to the current directory. Don't include the ending '/'  
+`bg_color` : The background fill color, transparent by default.  
+`autocreate_dirs` : Whether or not to create the directory if it exists. Default true  
+`format` : The format for the output, defaults to 'jpg'. Can be png, gif, etc.  
+`prefix` : Prefix for the output files. Defaults to 'tile'
+
+## Other things
+* Requires rmagick.
+* Might not work on Windows as written -- change the '/' for the output to '\\'
+
+
+## Credits
+This tiler is modified Guilhem's tile_image.rb tool, which is part of the ym4r project. The Tiler itself has been re-written, and TileParam is no longer used.  
+Thanks to Guilhem for the command-line portions and the sample ruby and rmagick code!
+
+
+## License
+imagetiler uses the MIT License.

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "imagetiler"
+    gemspec.summary = "Simple image tiler"
+		gemspec.description = "imagetiler is a simple command-line and ruby image tiler with support for multiple zoom levels and different image formats."
+    gemspec.email = "tanna22@gmail.com"
+    gemspec.homepage = "http://github.com/fofanafi/imagetiler"
+    gemspec.authors = ["Anna, Guilhem Vellut"]
+  end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/imagetiler.gemspec

@@ -0,0 +1,41 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{imagetiler}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anna, Guilhem Vellut"]
+  s.date = %q{2010-08-31}
+  s.description = %q{imagetiler is a simple command-line and ruby image tiler with support for multiple zoom levels and different image formats.}
+  s.email = %q{tanna22@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "imagetiler.gemspec",
+     "imagetiler.rb"
+  ]
+  s.homepage = %q{http://github.com/fofanafi/imagetiler}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple image tiler}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/imagetiler.rb

@@ -0,0 +1,197 @@
+#  Copyright (c) 2010 Anna <tanna22@gmail.com>
+#  Copyright (c) 2006 Guilhem Vellut <guilhem.vellut+ym4r@gmail.com>
+#  
+#  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.
+
+require 'rubygems'
+require 'RMagick'
+require 'optparse'
+require 'ostruct'
+
+class Tiler
+
+	TILE_SIZE = 256
+
+	attr_accessor(:output_dir, :zoom_levels, :bg_color, 
+								:format, :autocreate_dirs, :prefix)
+
+	def initialize()
+		@zoom_levels = 0..4
+		@bg_color = Magick::Pixel.new(255,255,255,0)
+		@format = "jpg"
+		@autocreate_dirs = true
+		@output_dir = "."
+		@prefix = "tile"
+	end
+	
+	# image_source can either be an RMagick Image or a string specifying the filename
+	def make_tiles(image_source, opts={})
+
+		# initializing and setting options and stuff
+		image = get_image(image_source)
+		if opts[:zoom_levels]
+			@zoom_levels = opts[:zoom_levels]
+		end
+		if opts[:bg_color] then @bg_color = opts[:bg_color] end
+		if opts[:format] then @format = opts[:format] end
+		if opts[:autocreate_dirs] then @autocreate_dirs = opts[:autocreate_dirs] end
+		if opts[:output_dir] then @output_dir = opts[:output_dir] end
+		@prefix = opts[:prefix] if opts[:prefix]
+
+		if @autocreate_dirs
+			create_dir(output_dir)
+		end
+
+		# pad image with background color so image is square
+		image_sq = pad_image(image)
+		image_length = image_sq.columns
+
+		zoom_levels.each do |zoom|
+			# get the number of tiles in each column and row
+			factor = 2 ** zoom
+
+			# get length of tiles for current zoom
+			tile_length = image_length / factor
+
+			0.upto(factor-1) do |col|
+				0.upto(factor-1) do |row|
+					# Image.crop(x,y,width,height,toss offset information)
+					tile = image_sq.crop(col*tile_length, row*tile_length,
+															 tile_length, tile_length, true)
+					tile.resize!(TILE_SIZE,TILE_SIZE)
+					tile.write("#{@output_dir}/#{prefix}_#{zoom}_#{col}_#{row}.#{@format}")
+				end
+			end
+		end
+	end
+
+	# Calculates the zoom level closest to native resolution.
+	# Returns a float for the zoom -- so, use zoom.ceil if you
+	# want the higher zoom, for example
+	def calc_native_res_zoom(image_source)
+		image = get_image(image_source)
+		side_length = calc_side_length(image)
+		zoom = log2(side_length)-log2(TILE_SIZE)
+		zoom = 0 if zoom < 0
+		zoom
+	end
+
+	# pad image to the lower right with bg_color so that the 
+	# image is square and that the max number of pixels
+	# is evenly divisible by the max number of tiles per side
+	def pad_image(image)
+		dimension_image = calc_side_length(image)
+		puts dimension_image
+		
+		bg_color = @bg_color
+		image_sq = Magick::Image.new(dimension_image, dimension_image) do
+			self.background_color = bg_color
+		end
+
+		image_sq.import_pixels(0,0,image.columns,image.rows,"RGBA",image.export_pixels(0,0,image.columns,image.rows,"RGBA"))
+	end
+
+	def get_image(image_source)
+		case image_source
+		when Magick::Image
+			image = image_source
+		else
+			image = Magick::ImageList::new(image_source)
+		end
+		return image
+	end
+
+	def calc_side_length(image)
+		long_side = [image.columns, image.rows].max
+		max_zoom = @zoom_levels.max
+		ceil = (long_side.to_f()/2**max_zoom).ceil
+		side_length = ceil*2**max_zoom
+	end
+
+	# if dir does not exist, create it
+	def create_dir(dir)
+		if !FileTest::directory?(dir)
+			Dir::mkdir(dir)
+		end
+	end
+
+	def log2(x)
+		Math.log(x)/Math.log(2)
+	end
+
+end
+
+# Runs this as a script
+def main
+
+	OptionParser.accept(Range, /(\d+)\.\.(\d+)/) do |range,start,finish|
+		Range.new(start.to_i,finish.to_i)
+	end
+
+	OptionParser.accept(Magick::Pixel,/(\d+),(\d+),(\d+),(\d+)/) do |pixel, r,g,b,a|
+		Magick::Pixel.new(r.to_f,g.to_f,b.to_f,a.to_f)
+	end
+
+	options = {}
+
+	opts = OptionParser.new do |opts|
+		opts.banner = "Image Tiler for Google Maps\nUsage: tile_image.rb [options] IMAGE_FILE \nExample: tile_image.rb -o ./tiles -z 11..12 -p 602,768,11,78,112,1.91827348 ./input_files/map.jpg"
+		opts.separator "" 
+		opts.on("-o","--output OUTPUT_DIR","Directory where the tiles will be created") do |dir| 
+			options[:output_dir] = dir
+		end
+		opts.on("-f","--format FORMAT","Image format in which to get the file (gif, jpeg, png...). Is jpg by default") do |format|
+			options[:format] = format
+		end
+		opts.on("-z","--zoom_levels ZOOM_RANGE",Range,"Range of zoom values at which the tiles must be generated. Is 0..4 by default") do |range|
+			options[:zoom_levels] = range
+		end
+		opts.on("-b","--background COLOR",Magick::Pixel,"Background color components. Is fully transparent par default") do |bg|
+			options[:bg_color] = bg
+		end
+		opts.on("-p","--prefix PREFIX","Prefix to file output. Is 'tile' by default") do |prefix|
+			options[:prefix] = prefix
+		end
+		opts.on_tail("-h", "--help", "Show this message") do
+			puts opts
+			exit
+		end
+	end
+
+	opts.parse!(ARGV)
+
+	#test the presence of all the options and exit with an error message
+	error = []
+	error << "No output directory defined (-o,--output)" if options[:output_dir].nil?
+	error << "No input files defined" if ARGV.empty?
+
+	unless error.empty?
+		puts error * "\n" + "\n\n"
+		puts opts
+		exit
+	end
+
+	t = Tiler.new
+	t.make_tiles(ARGV[0], options) # ignore all input files but first
+
+end
+
+# Executes the main method if this file is being run as a script.
+if $0 == __FILE__
+	main
+end
+
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: imagetiler
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anna, Guilhem Vellut
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-31 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: imagetiler is a simple command-line and ruby image tiler with support for multiple zoom levels and different image formats.
+email: tanna22@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- imagetiler.gemspec
+- imagetiler.rb
+has_rdoc: true
+homepage: http://github.com/fofanafi/imagetiler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple image tiler
+test_files: []
+