spcore 0.1.3 → 0.1.4

data/ChangeLog.rdoc

@@ -24,3 +24,7 @@ Add EnvelopeDetector#attack_time= and EnvelopeDetector#release_time=
 ** Discrete and Polynomial resampling classes, each with an .upsample method.
 ** Plotter class to make graphing with gnuplot easier. Has #plot_1d and #plot_2d methods.
 ** Signal class for testing convenience. Contains signal data and has convenience methods for plotting, correlation, energy, etc.
+
+=== 0.1.4 / 2013-02-19
+
+Fixed gemspec to always depend on gnuplot (not just for development).

data/README.rdoc

@@ -2,7 +2,7 @@
 
 * {Homepage}[https://rubygems.org/gems/spcore]
 * {Documentation}[http://rubydoc.info/gems/spcore/frames]
-* {Email}[mailto:jamestunnell at lavabit.com]
+* {Email}[jamestunnell@lavabit.com]
 
 == Description
 
@@ -10,20 +10,20 @@ A library of signal processing methods and classes.
 
 == Features
 
-Resampling (discrete up, down and up/down, polynomial up, and hybrid up/down)
-FFT transform (forward and inverse)
-DFT transform (forward and inverse)
-Windows (Blackman, Hamming, etc.)
-Windowed sinc filter for lowpass and highpass.
-Dual windowed sinc filter for bandpass and bandstop.
-Interpolation (linear and polynomial)
-Data plotting via gnuplot (must be installed to use).
-Delay line
-Biquad filters
-Envelope detector
-Conversion from dB-linear and linear-dB
-Oscillator with selectable wave type (sine, square, triangle, sawtooth)
-Signal abstraction class.
+* Resampling (discrete up, down and up/down, polynomial up, and hybrid up/down)
+* FFT transform (forward and inverse)
+* DFT transform (forward and inverse)
+* Windows (Blackman, Hamming, etc.)
+* Windowed sinc filter for lowpass and highpass.
+* Dual windowed sinc filter for bandpass and bandstop.
+* Interpolation (linear and polynomial)
+* Data plotting via gnuplot (must be installed to use).
+* Delay line
+* Biquad filters
+* Envelope detector
+* Conversion from dB-linear and linear-dB
+* Oscillator with selectable wave type (sine, square, triangle, sawtooth)
+* Signal abstraction class
 
 == Examples
 

data/lib/spcore/core/signal.rb

@@ -16,8 +16,8 @@ class Signal
 
   # A new instance of Signal.
   #
-  # @param [Hash] args Hashed arguments. Required keys are :data and :sample_rate.
-  #                    See ARG_SPECS for more details.
+  # @param [Hash] hashed_args Hashed arguments. Required keys are :data and
+  #                           :sample_rate. See ARG_SPECS for more details.
   def initialize hashed_args
     hash_make Signal::ARG_SPECS, hashed_args
   end
@@ -43,9 +43,14 @@ class Signal
     @data[arg]
   end
   
-  def plot_data
-    plotter = Plotter.new(:title => "signal data sequence", :xtitle => "sample numbers", :ytitle => "sample values")
-    plotter.plot_1d "signal data" => @data
+  # Plot the signal data, either against sample numbers or fraction of total samples.
+  # @param plot_against_fraction If false, plot data against sample number. If true,
+  #                              plot against fraction of total samples.
+  def plot_data plot_against_fraction
+    xtitle = (plot_against_fraction ? "fraction of total samples" : "sample numbers")
+    plotter = Plotter.new(:title => "signal data sequence", :xtitle => xtitle, :ytitle => "sample values")
+    titled_sequence = {"signal data" => @data}
+    plotter.plot_1d titled_sequence, plot_against_fraction
   end
   
   # Increase the sample rate of signal data by the given factor using

data/lib/spcore/interpolation/interpolation.rb

@@ -17,7 +17,7 @@ class Interpolation
   # Given 2 sample points, interpolates a value anywhere between the two points.
   #
   # @param [Numeric] y0 First (left) y-value
-  # @param [Numeric] y0 Second (right) y-value
+  # @param [Numeric] y1 Second (right) y-value
   # @param [Numeric] x Percent distance (along the x-axis) between the two y-values
   def self.linear y0, y1, x
     raise ArgumentError, "x is not between 0.0 and 1.0" unless x.between?(0.0,1.0)

data/lib/spcore/util/plotter.rb

@@ -26,8 +26,10 @@ class Plotter
   
   # Plot XY datapoints.
   # @param [Hash] titled_hashes A hash that maps dataset titles to data. The data itself
-  #                             is a hash also, that maps x values to y values. For example,
-  #                             plot_2d could be called passing it the hash { "somedata" => {0.0 => 4.0, 1.0 => 2.0}}
+  #                             is a hash also, that maps x values to y values.
+  #
+  # @example
+  #   Plotter.plot_2d "somedata" => {0.0 => 4.0, 1.0 => 2.0}
   def plot_2d titled_hashes
     datasets = []
     titled_hashes.each do |title, hash|
@@ -45,10 +47,12 @@ class Plotter
   # Plot a sequence of values.
   # @param [Hash] titled_sequences A hash that maps sequence titles to data. The data itself
   #                             is an array of values. In the plot, values will be mapped to
-  #                             their index in the sequence. For example, plot_1d could be
-  #                             called passing it the hash { "somedataseq" => [0,2,3,6,3,-1]}
+  #                             their index in the sequence.
   # @param plot_against_fraction If true, instead of plotting samples against sample number, plot
   #                              them against the fraction (sample_number / total_samples).
+  #
+  # @example
+  #   Plotter.plot_1d "somedata" => [0,2,3,6,3,-1]
   def plot_1d titled_sequences, plot_against_fraction = false
     datasets = []
     titled_sequences.each do |title, sequence|

data/lib/spcore/version.rb

@@ -1,5 +1,5 @@
 # A library of signal processing methods and classes.
 module SPCore
   # spcore version
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spcore.gemspec

@@ -8,20 +8,20 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{A library of signal processing methods and classes.}
   gem.description   = <<DESCRIPTION
 Contains core signal processing methods and classes, including:
-  Resampling (discrete up, down and up/down, polynomial up, and hybrid up/down)
-  FFT transform (forward and inverse)
-  DFT transform (forward and inverse)
-  Windows (Blackman, Hamming, etc.)
-  Windowed sinc filter for lowpass and highpass.
-  Dual windowed sinc filter for bandpass and bandstop.
-  Interpolation (linear and polynomial)
-  Data plotting via gnuplot (must be installed to use).
-  Delay line
-  Biquad filters
-  Envelope detector
-  Conversion from dB-linear and linear-dB
-  Oscillator with selectable wave type (sine, square, triangle, sawtooth)
-  Signal abstraction class.
+  * Resampling (discrete up, down and up/down, polynomial up, and hybrid up/down).
+  * FFT transform (forward and inverse).
+  * DFT transform (forward and inverse).
+  * Windows (Blackman, Hamming, etc.).
+  * Windowed sinc filter for lowpass and highpass.
+  * Dual windowed sinc filter for bandpass and bandstop.
+  * Interpolation (linear and polynomial).
+  * Data plotting via gnuplot (must be installed to use).
+  * Delay line.
+  * Biquad filters.
+  * Envelope detector.
+  * Conversion from dB-linear and linear-dB.
+  * Oscillator with selectable wave type (sine, square, triangle, sawtooth).
+  * Signal abstraction class.
 
 DESCRIPTION
   gem.license       = "MIT"
@@ -35,11 +35,11 @@ DESCRIPTION
   gem.require_paths = ['lib']
 
   gem.add_dependency 'hashmake'
+  gem.add_dependency 'gnuplot'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.add_development_dependency 'rake', '~> 0.8'
   gem.add_development_dependency 'rspec', '~> 2.4'
   gem.add_development_dependency 'yard', '~> 0.8'
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'gnuplot'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spcore
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,31 +123,15 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gnuplot
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: ! "Contains core signal processing methods and classes, including:\n
-  \ Resampling (discrete up, down and up/down, polynomial up, and hybrid up/down)\n
-  \ FFT transform (forward and inverse)\n  DFT transform (forward and inverse)\n  Windows
-  (Blackman, Hamming, etc.)\n  Windowed sinc filter for lowpass and highpass.\n  Dual
-  windowed sinc filter for bandpass and bandstop.\n  Interpolation (linear and polynomial)\n
-  \ Data plotting via gnuplot (must be installed to use).\n  Delay line\n  Biquad
-  filters\n  Envelope detector\n  Conversion from dB-linear and linear-dB\n  Oscillator
-  with selectable wave type (sine, square, triangle, sawtooth)\n  Signal abstraction
-  class.\n\n"
+  \ * Resampling (discrete up, down and up/down, polynomial up, and hybrid up/down).\n
+  \ * FFT transform (forward and inverse).\n  * DFT transform (forward and inverse).\n
+  \ * Windows (Blackman, Hamming, etc.).\n  * Windowed sinc filter for lowpass and
+  highpass.\n  * Dual windowed sinc filter for bandpass and bandstop.\n  * Interpolation
+  (linear and polynomial).\n  * Data plotting via gnuplot (must be installed to use).\n
+  \ * Delay line.\n  * Biquad filters.\n  * Envelope detector.\n  * Conversion from
+  dB-linear and linear-dB.\n  * Oscillator with selectable wave type (sine, square,
+  triangle, sawtooth).\n  * Signal abstraction class.\n\n"
 email: jamestunnell@lavabit.com
 executables: []
 extensions: []
@@ -225,7 +225,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 272931151
+      hash: -91888305
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 272931151
+      hash: -91888305
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23