lttb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c647e0772742ee162459334ede93428d12a7c79c
+  data.tar.gz: 525ce8a01dab924bd16d94e5cad4981e9173194f
+SHA512:
+  metadata.gz: fd1e18e0a2e234c49af4d9a865aae858f262e5249b82464012e4f2d2bc3d661f0e1338261a03a06bcddb49f4eb1674da2bc2bc96986e8eb4b0b4ee86609cf055
+  data.tar.gz: 62da5c7ea2c2990aa83ea5008f11c71494ba74cc1c2792a486e84d241535499057147a382f3e9e9a6e7b488a17b9d5917ffd5d9d236383ed130e3829ce109822

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jubke
+
+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,52 @@
+# lttb - Largest-Triangle-Three-Buckets (Ruby)
+This is an implementation of the Largest-Triangle-Three-Buckets (LTTB) downsampling algorithm in Ruby.
+
+The code has been translated from the work of Sveinn Steinarsson in his plugin for Flot charts.
+More information is available on [his page](https://github.com/sveinn-steinarsson/flot-downsample/),
+and you can find the thesis describing the algorithm [here](http://skemman.is/handle/1946/15343).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lttb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lttb
+
+## Usage
+
+Data passed should be in the format [[x1,y1],[x2,y2]].
+```ruby
+  data = [[1, 1], [2, 4], [3, 9], [4, 16], [5, 25]]
+  threshold = 3
+  Lttb.process(data, threshold)
+  # => [1, 1], [3, 9], [5, 25]]
+```
+
+Pass `:dates => true` to process DateTime objects correctly.
+```ruby
+  Lttb.process(data, threshold, dates: true)
+```
+
+## Known limitations
+
+Does not support gaps (null values) in the data array.
+X-values must be in a strictly increasing order.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Jubke/lttb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lttb"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lttb.rb

@@ -0,0 +1,2 @@
+require "lttb/version"
+require "lttb/process"

data/lib/lttb/process.rb

@@ -0,0 +1,138 @@
+module Lttb
+
+  # Return a downsampled version of data.
+  # Parameters
+  # ----------
+  # data: list of lists/tuples
+  #     data must be formated this way: [[x,y], [x,y], [x,y], ...]
+  #                                 or: [(x,y), (x,y), (x,y), ...]
+  # threshold: int
+  #     threshold must be >= 2 and <= to the len of data
+  # Returns
+  # -------
+  # data, but downsampled using threshold
+  def self.largest_triangle_three_buckets(data, threshold, options = {})
+
+    # Check if data and threshold are valid
+    check_data(data)
+    check_threshold(threshold)
+    check_tuples(data) if options[:check_tuples]
+
+    data = handle_dates(data) if options[:dates]
+
+    # cache data size
+    data_length = data.size
+
+    # Nothing to do?
+    return data if threshold >= data_length || threshold == 0
+
+    # Bucket size. Leave room for start and end data points
+    every = (data_length - 2) / (threshold - 2)
+
+    a = 0 # Initially a is the first point in the triangle
+    sampled = [data[a]] # Always add the first point
+
+    (0..(threshold - 3)).each do |i|
+      # Calculate point average for next bucket (containing c)
+      avg_x = 0
+      avg_y = 0
+      avg_range_start = (((i + 1) * every).floor + 1).to_i
+      avg_range_end = (((i + 2) * every).floor + 1).to_i
+      avg_range_end = avg_range_end < data_length ? avg_range_end : data_length
+
+      avg_range_length = avg_range_end - avg_range_start
+
+      while avg_range_start < avg_range_end
+        avg_x += data[avg_range_start][0]
+        avg_y += data[avg_range_start][1]
+
+        avg_range_start += 1 # increment
+      end
+
+      avg_x /= avg_range_length
+      avg_y /= avg_range_length
+
+      # Get the range for this bucket
+      range_offs = (((i + 0) * every).floor + 1).to_i
+      range_to = (((i + 1) * every).floor + 1).to_i
+      range_to = range_to < data_length - 1 ? range_to : data_length - 1
+
+      # Point a
+      point_ax = data[a][0]
+      point_ay = data[a][1]
+
+      max_area = area = -1
+
+      while range_offs < range_to
+        # Calculate triangle area over three buckets
+        area = (
+          (point_ax - avg_x) * (data[range_offs][1] - point_ay) -
+          (point_ax - data[range_offs][0]) * (avg_y - point_ay)
+        ).abs * 0.5
+
+        if area > max_area
+          max_area = area
+          max_area_point = data[range_offs]
+          next_a = range_offs # Next a is this b
+        end
+
+        range_offs += 1 # increment
+      end
+
+      sampled.push(max_area_point) # Pick this point from the bucket
+      a = next_a # This a is the next a (chosen b)
+    end
+
+    sampled.push(data[data.size - 1]) # Always add last
+
+    sampled = as_dates(sampled) if options[:dates]
+    sampled
+  end
+
+  class << self
+
+    alias process largest_triangle_three_buckets
+
+    private
+
+    def check_data(data)
+      raise LttbException, 'data is not an array' unless data.is_a? Array
+    end
+
+    def check_threshold(threshold)
+      return if threshold.is_a?(Integer) && threshold > 2
+      raise LttbException, "threshold not well defined: #{threshold}"
+    end
+
+    def check_tuples(data)
+      data.each do |i|
+        next if i.is_a?(Array) && i.size == 2
+        raise LttbException, 'datapoints are not lists or tuples'
+      end
+    end
+
+    def handle_dates(data)
+      data.map do |d|
+        d[0] = d[0].strftime('%Q').to_i
+        d
+      end
+    end
+
+    def as_dates(data)
+      data.map do |d|
+        d[0] = DateTime.strptime(d[0].to_s, '%Q')
+        d
+      end
+    end
+
+  end
+
+  class LttbException < StandardError
+
+    def initialize(msg)
+      super msg
+    end
+
+  end
+
+end

data/lib/lttb/version.rb

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

data/lttb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lttb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lttb"
+  spec.version       = Lttb::VERSION
+  spec.authors       = ["Jubke"]
+  spec.email         = ["luebke.julian@gmail.com"]
+
+  spec.summary       = %q{Largest-Triangle-Three-Buckets (LTTB) downsampling algorithm in Ruby.}
+  spec.description   = %q{The code has been translated from the work of Sveinn Steinarsson in his plugin for Flot charts.
+More information is available on [his page](https://github.com/sveinn-steinarsson/flot-downsample/),
+and you can find the thesis describing the algorithm [here](http://skemman.is/handle/1946/15343).}
+  spec.homepage      = "https://github.com/Jubke/lttb"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: lttb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jubke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  The code has been translated from the work of Sveinn Steinarsson in his plugin for Flot charts.
+  More information is available on [his page](https://github.com/sveinn-steinarsson/flot-downsample/),
+  and you can find the thesis describing the algorithm [here](http://skemman.is/handle/1946/15343).
+email:
+- luebke.julian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lttb.rb
+- lib/lttb/process.rb
+- lib/lttb/version.rb
+- lttb.gemspec
+homepage: https://github.com/Jubke/lttb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Largest-Triangle-Three-Buckets (LTTB) downsampling algorithm in Ruby.
+test_files: []