rclusters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1746690c3d66ea1c1addace4ced13de169e837f6
+  data.tar.gz: fd7e9628708141a43da2dba11f311e1677169622
+SHA512:
+  metadata.gz: 3df198e536e2f89e86fa732979ef3e1cf48d3b10d078aa914d0145165245f16fa95e193ca7ae798c442cb72105d95d8f8edf435f5122be7f894a961060584f01
+  data.tar.gz: 92a991153f4d407b78b870ffd232e225418d0e9e4fdece0f8867a382b058118673010b48776964f1575168ac04d1b5cc5deafad420a482b25b307c279e5e9500

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rclusters.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruno Salerno
+
+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,117 @@
+# Rclusters
+
+RClusters is a Ruby gem that creates clusters from a points hash using either pixel or surface distance calculations.
+The input is a hash and the output is another hash. Right now, **a max_distance value has to be provided**.
+
+Inspired by [this post](http://www.appelsiini.net/2008/introduction-to-marker-clustering-with-google-maps).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rclusters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rclusters
+
+## Usage
+
+Calculating clusters based on pixel distances:
+```ruby
+require 'rclusters'
+
+opts = {}
+
+rcluster = RClusters::PixelDistance.new(opts)
+
+data = [{:lat=>-23.607581, :lon=>-46.630046,...},{:lat=>-23.511634, :lon=>-46.71541,...},...]
+
+clusters = rcluster.calculate(data,2000) # 2000px as max_distance
+```
+
+Calculating clusters based on surface distances:
+```ruby
+require 'rclusters'
+
+opts = {}
+
+rcluster = RClusters::SurfaceDistance.new(opts)
+
+data = [{:lat=>-23.607581, :lon=>-46.630046,...},{:lat=>-23.511634, :lon=>-46.71541,...},...]
+
+clusters = rcluster.calculate(data,200) # 200 mts as max_distance
+```
+
+
+Result example:
+
+```ruby
+[ {:size=>9,
+   :cluster=>
+   [{:lat=>-23.607581, :lon=>-46.630046,...},
+    {:lat=>-23.511634, :lon=>-46.71541,...},
+    {:lat=>-23.56957, :lon=>-46.628092,...},
+    {:lat=>-23.611887, :lon=>-46.67767,...}]},
+  {:size=>1, 
+   :cluster=>[{:lat=>-22.4356084066, :lon=>-46.97118445}]},
+  {:size=>1, 
+   :cluster=>[{:lat=>-23.472742, :lon=>-46.600197}]}
+ ]
+             
+```
+
+## Public Methods
+
+```
+calculate(Array of hashes points, Integer max_distance, opts) 
+```
+Args are optional if passed in instantiation.
+
+### Options
+Either in instantiation or in the `calculate` method.
+
+#### Common
+
+(Optional if passed as args in the `calculate` method)
+
+| Option        | Info       | Values |      
+---------|-------|------
+| `points`| Points to be clustered |Array of points [hashes]|
+| `max_distance`  | Maximum distance between points in order to cluster them | Integer. Unit `px` using de `PixelDistance` class or the one matching `default_units` option if using `SurfaceDistance`  |
+
+#### PixelDistance
+
+| Option        | Info       | Values |      
+---------|-------|------
+| `zoom`  | Distance is processed by a Google Maps type zoom scale | Integer . Default: `12` | 
+| `offset` | Used for translation to projected coordinates | Default: `268435456`|
+| `radius` | Earth radius | Default: `85445659.4471`|
+
+#### SurfaceDistance
+
+| Option        | Info       | Values |      
+---------|-------|------
+| `default_units`  | Geokit option| Symbol . Default: `:meters`. Others: `:miles`, `:kms`, `:nms` | 
+| `default_formula` | Geokit option | Symbol. Default: `:sphere`.|
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rclusters/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rclusters"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rclusters/base.rb

@@ -0,0 +1,51 @@
+module RClusters
+  class Base
+    def initialize(opts = {})
+      @points = opts[:points]
+      @max_distance = opts[:max_distance]
+    end
+
+    def calculate(points = nil,max_distance = nil, opts={})
+      points ||= @points
+      max_distance ||= @max_distance
+      cluster(points,max_distance,opts)
+    end
+
+    private
+
+    def distance(lat1,lon1,lat2,lon2,opts={})
+      # To be implemented by specific classes
+    end
+
+    def cluster(points, max_distance,opts)
+      return unless points and max_distance
+
+      clusters = []
+      points = points.clone
+      points.count.times do
+        point = points.pop
+
+        next if point.nil?
+
+        cluster = []
+        points.each_with_index {|target, index|
+          next if target.nil? or point.nil?
+
+          distance = distance(point[:lat], point[:lon], target[:lat], target[:lon],opts)
+
+          if max_distance > distance
+            cluster.push(target)
+            points[index]= nil
+          end
+        }
+
+        cluster.push(point)
+        clusters.push(cluster)
+      end
+
+      clusters.map {|cl|
+        {:size =>cl.count, :cluster=>cl}
+      }
+    end
+  end
+end

data/lib/rclusters/pixel_distance.rb

@@ -0,0 +1,37 @@
+module RClusters
+  class PixelDistance < Base
+    OFFSET = 268435456
+    RADIUS = 85445659.4471
+    ZOOM = 12
+
+    def initialize(opts = {})
+      super
+      @offset = opts[:offset] || OFFSET
+      @radius = opts[:radius] || RADIUS
+      @zoom = opts[:zoom] || ZOOM
+    end
+
+    private
+
+    def distance(lat1,lon1,lat2,lon2,opts={})
+      zoom = opts[:zoom] || @zoom
+
+      x1 = lon_to_x(lon1)
+      y1 = lat_to_y(lat1)
+      x2 = lon_to_x(lon2)
+      y2 = lat_to_y(lat2)
+
+      Math.sqrt((x1-x2)**2 + (y1-y2)**2).to_i >> (21 - zoom)
+    end
+
+    def lon_to_x(lon)
+      (@offset + @radius * lon * Math::PI / 180).to_i
+    end
+
+    def lat_to_y(lat)
+      (@offset + @radius *
+          Math.log((1 + Math.sin(lat * Math::PI / 180)) /
+                       (1 - Math.sin(lat * Math::PI / 180))) / 2)
+    end
+  end
+end

data/lib/rclusters/surface_distance.rb

@@ -0,0 +1,13 @@
+require 'openssl'
+require 'geokit'
+
+module RClusters
+  class SurfaceDistance < Base
+    def distance(lat1,lon1,lat2,lon2,opts={})
+      Geokit::default_units = opts[:default_units] || :meters
+      Geokit::default_formula = opts[:default_formula] || :sphere
+
+      Geokit::LatLng.new(lat1,lon1).distance_to(Geokit::LatLng.new(lat2,lon2))
+    end
+  end
+end

data/lib/rclusters/version.rb

@@ -0,0 +1,3 @@
+module RClusters
+  VERSION = "0.1.0"
+end

data/lib/rclusters.rb

@@ -0,0 +1,4 @@
+require_relative 'rclusters/base'
+require_relative 'rclusters/pixel_distance'
+require_relative 'rclusters/surface_distance'
+require_relative 'rclusters/version'

data/rclusters.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rclusters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rclusters"
+  spec.version       = RClusters::VERSION
+  spec.authors       = ["Bruno Salerno"]
+  spec.email         = ["br.salerno@gmail.com"]
+
+  spec.summary       = 'Points clustering for Ruby based on distance.'
+  spec.description   = 'RClusters creates clusters from a points hash using either pixel or surface distance calculations.'
+  spec.homepage      = 'https://github.com/BrunoSalerno/rclusters'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "geokit", "~> 1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rclusters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Salerno
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: RClusters creates clusters from a points hash using either pixel or surface
+  distance calculations.
+email:
+- br.salerno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rclusters.rb
+- lib/rclusters/base.rb
+- lib/rclusters/pixel_distance.rb
+- lib/rclusters/surface_distance.rb
+- lib/rclusters/version.rb
+- rclusters.gemspec
+homepage: https://github.com/BrunoSalerno/rclusters
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Points clustering for Ruby based on distance.
+test_files: []