spcore 0.1.7 → 0.1.8

data/ChangeLog.rdoc

@@ -37,6 +37,10 @@ Adjust project documentation.
 
 Update to be compatible with hashmake-0.1.6.
 
-=== 0.1.7  2013-04-18
+=== 0.1.7 / 2013-04-18
 
-Require all sample rate args to be Fixnum.
+Require all sample rate args to be Fixnum.
+
+=== 0.1.8 / 2013-05-03
+
+Add Envelope and Extrema classes, for signal analysis.

data/README.rdoc

@@ -24,6 +24,7 @@ A library of signal processing methods and classes.
 * Conversion from dB-linear and linear-dB
 * Oscillator with selectable wave type (sine, square, triangle, sawtooth)
 * Signal abstraction class
+* Extrema & Envelope measurement
 
 == Examples
 

data/lib/spcore.rb

@@ -4,9 +4,10 @@ require 'spcore/version'
 require 'spcore/core/circular_buffer'
 require 'spcore/core/constants'
 require 'spcore/core/delay_line'
-require 'spcore/core/envelope_detector'
 require 'spcore/core/oscillator'
 require 'spcore/core/signal'
+require 'spcore/core/extrema'
+require 'spcore/core/envelope'
 
 require 'spcore/windows/bartlett_hann_window'
 require 'spcore/windows/bartlett_window'
@@ -48,3 +49,4 @@ require 'spcore/util/plotter'
 require 'spcore/util/saturation'
 require 'spcore/util/scale'
 require 'spcore/util/signal_generator'
+require 'spcore/util/envelope_detector'

data/lib/spcore/core/envelope.rb

@@ -0,0 +1,58 @@
+module SPCore
+# Determines the envelope of given samples. Unlike the EnvelopeDetector, this
+# operates on a signal (time-series data) after it is recieved, not
+# sample-by-sample. As a result, it provides the envelope as an entire signal.
+#
+# @author James Tunnell
+class Envelope < Signal
+  
+  attr_reader :data
+  
+  def initialize samples
+    # combine absolute values of positive maxima and negative minima
+    extrema = Extrema.new(samples)
+    points = {}
+    extrema.minima.each do |idx,val|
+      if val <= 0.0
+        points[idx] = val.abs
+      end
+    end
+    
+    extrema.maxima.each do |idx,val|
+      if val >= 0.0
+        points[idx] = val.abs
+      end
+    end
+    
+    # add in first and last samples so the envelope follows entire signal
+    points[0] = samples[0].abs
+    points[samples.count - 1] = samples[samples.count - 1].abs
+    
+    indices = points.keys.sort
+    @data = Array.new(samples.count, 0)
+    
+    # interpolate between all the extrema for the rest of the values. We
+    # manually added first/last index so the whole signal should be covered
+    # by this
+    for i in 1...indices.count
+      l_idx = indices[i-1]
+      r_idx = indices[i]
+      
+      l_val = points[l_idx]
+      r_val = points[r_idx]
+      
+      @data[l_idx] = l_val
+      @data[r_idx] = r_val
+      
+      idx_span = r_idx - l_idx
+      
+      for j in (l_idx + 1)...(r_idx)
+        x = (j - l_idx).to_f / idx_span
+        y = Interpolation.linear l_val, r_val, x
+        @data[j] = y
+      end
+    end
+  end
+
+end
+end

data/lib/spcore/core/extrema.rb

@@ -0,0 +1,55 @@
+module SPCore
+# Finds extrema (minima and maxima).
+class Extrema
+  
+  attr_reader :minima, :maxima, :extrema
+  
+  def initialize samples
+    @minima = {}
+    @maxima = {}
+    
+    global_min_idx = 0
+    global_min_val = samples[0]
+    global_max_idx = 0
+    global_max_val = samples[0]
+    
+    diffs = []
+    for i in (1...samples.count)
+      diffs.push(samples[i] - samples[i-1])
+      
+      if samples[i] < global_min_val
+        global_min_idx = i
+        global_min_val = samples[i]
+      end
+      
+      if samples[i] > global_max_val
+        global_max_idx = i
+        global_max_val = samples[i]
+      end
+    end
+    @minima[global_min_idx] = global_min_val
+    @maxima[global_max_idx] = global_max_val
+    
+    is_positive = diffs.first > 0.0 # starting off with positive difference?
+    
+    # at zero crossings there is a local maxima/minima    
+    for i in (1...diffs.count)
+      if is_positive
+        # at positive-to-negative transition there is a local maxima
+        if diffs[i] <= 0.0
+          @maxima[i] = samples[i]
+          is_positive = false
+        end
+      else
+        # at negative-to-positive transition there is a local minima
+        if diffs[i] > 0.0
+          @minima[i] = samples[i]
+          is_positive = true
+        end
+      end
+    end
+    
+    @extrema = @minima.merge(@maxima)    
+  end
+end 
+end

data/lib/spcore/core/signal.rb

@@ -89,7 +89,7 @@ class Signal
   # polynomial interpolation.
   # @param [Fixnum] upsample_factor Increase the sample rate by this factor.
   def upsample_polynomial upsample_factor
-    @data = PolynomialResampling.upsample @data, @sample_rate, upsample_factor
+    @data = PolynomialResampling.upsample @data, upsample_factor
     @sample_rate *= upsample_factor
     return self
   end
@@ -134,24 +134,14 @@ class Signal
     return @data.inject(0.0){|sum,x| sum + (x * x)}
   end
   
-  # Return a 
-  def envelope attack_time, release_time
-    raise ArgumentError, "attack_time #{attack_time } is less than or equal to zero" if attack_time <= 0.0
-    raise ArgumentError, "release_time #{release_time} is less than or equal to zero" if release_time <= 0.0
-    
-    env_detector = EnvelopeDetector.new(:attack_time => attack_time, :release_time => release_time, :sample_rate => @sample_rate)
-    
-    envelope = Array.new(@data.count)
-    
-    for i in 0...@data.count do
-      envelope[i] = env_detector.process_sample @data[i]
-    end
-    
-    return envelope
+  # Determine the envelope of the current Signal and return the resulting data
+  # in a new Signal object.
+  def envelope
+    return Envelope.new(@data)
   end
   
   # Add data in array or other signal to the beginning of current data.
-  def prepend other
+  def prepend! other
     if other.is_a?(Array)
       @data = other.concat @data
     elsif other.is_a?(Signal)
@@ -161,7 +151,7 @@ class Signal
   end
 
   # Add data in array or other signal to the end of current data.
-  def append other
+  def append! other
     if other.is_a?(Array)
       @data = @data.concat other
     elsif other.is_a?(Signal)
@@ -173,7 +163,7 @@ class Signal
   # Add value, values in array, or values in other signal to the current
   # data values, and update the current data with the results.
   # @param other Can be Numeric (add same value to all data values), Array, or Signal.
-  def +(other)
+  def add!(other)
     if other.is_a?(Numeric)
       @data.each_index do |i|
         @data[i] += other
@@ -193,11 +183,37 @@ class Signal
     end
     return self
   end
+
+  # Add value, values in array, or values in other signal to the current
+  # data values, and return a new Signal object with the results.
+  # @param other Can be Numeric (add same value to all data values), Array, or Signal.
+  def add(other)
+    new_data = Array.new(@data.size)
+    
+    if other.is_a?(Numeric)
+      @data.each_index do |i|
+        new_data[i] = @data[i] + other
+      end
+    elsif other.is_a?(Signal)
+      raise ArgumentError, "other.data.size #{other.size} is not equal to data.size #{@data.size}" if other.data.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] + other.data[i]
+      end
+    elsif other.is_a?(Array)
+      raise ArgumentError, "other.size #{other.size} is not equal to data.size #{@data.size}" if other.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] + other[i]
+      end
+    else
+      raise ArgumentError, "other is not a Numeric, Signal, or Array"
+    end
+    return Signal.new(:data => new_data, :sample_rate => @sample_rate)
+  end
   
   # Subtract value, values in array, or values in other signal from the current
   # data values, and update the current data with the results.
   # @param other Can be Numeric (subtract same value from all data values), Array, or Signal.
-  def -(other)
+  def subtract!(other)
     if other.is_a?(Numeric)
       @data.each_index do |i|
         @data[i] -= other
@@ -218,11 +234,37 @@ class Signal
     return self
   end
 
+  # Subtract value, values in array, or values in other signal from the current
+  # data values, and return a new Signal object with the results.
+  # @param other Can be Numeric (subtract same value from all data values), Array, or Signal.
+  def subtract(other)
+    new_data = Array.new(@data.size)
+    
+    if other.is_a?(Numeric)
+      @data.each_index do |i|
+        new_data[i] = @data[i] - other
+      end
+    elsif other.is_a?(Signal)
+      raise ArgumentError, "other.data.size #{other.size} is not equal to data.size #{@data.size}" if other.data.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] - other.data[i]
+      end
+    elsif other.is_a?(Array)
+      raise ArgumentError, "other.size #{other.size} is not equal to data.size #{@data.size}" if other.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] - other[i]
+      end
+    else
+      raise ArgumentError, "other is not a Numeric, Signal, or Array"
+    end
+    return Signal.new(:data => new_data, :sample_rate => @sample_rate)
+  end
+  
   # Multiply value, values in array, or values in other signal with the current
   # data values, and update the current data with the results.
   # @param other Can be Numeric (multiply all data values by the same value),
   #              Array, or Signal.  
-  def *(other)
+  def multiply!(other)
     if other.is_a?(Numeric)
       @data.each_index do |i|
         @data[i] *= other
@@ -243,11 +285,38 @@ class Signal
     return self
   end
   
+  # Multiply value, values in array, or values in other signal with the current
+  # data values, and return a new Signal object with the results.
+  # @param other Can be Numeric (multiply all data values by the same value),
+  #              Array, or Signal.  
+  def multiply(other)
+    new_data = Array.new(@data.size)
+    
+    if other.is_a?(Numeric)
+      @data.each_index do |i|
+        new_data[i] = @data[i] * other
+      end
+    elsif other.is_a?(Signal)
+      raise ArgumentError, "other.data.size #{other.size} is not equal to data.size #{@data.size}" if other.data.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] * other.data[i]
+      end
+    elsif other.is_a?(Array)
+      raise ArgumentError, "other.size #{other.size} is not equal to data.size #{@data.size}" if other.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] * other[i]
+      end
+    else
+      raise ArgumentError, "other is not a Numeric, Signal, or Array"
+    end
+    return Signal.new(:data => new_data, :sample_rate => @sample_rate)
+  end
+  
   # Divide value, values in array, or values in other signal into the current
   # data values, and update the current data with the results.
   # @param other Can be Numeric (divide same all data values by the same value),
   #              Array, or Signal.
-  def /(other)
+  def divide!(other)
     if other.is_a?(Numeric)
       @data.each_index do |i|
         @data[i] /= other
@@ -268,10 +337,37 @@ class Signal
     return self
   end
 
-  alias_method :add, :+
-  alias_method :subtract, :-
-  alias_method :multiply, :*
-  alias_method :divide, :/
+  # Divide value, values in array, or values in other signal into the current
+  # data values, and return a new Signal object with the results.
+  # @param other Can be Numeric (divide same all data values by the same value),
+  #              Array, or Signal.
+  def divide(other)
+    new_data = Array.new(@data.size)
+    
+    if other.is_a?(Numeric)
+      @data.each_index do |i|
+        new_data[i] = @data[i] / other
+      end
+    elsif other.is_a?(Signal)
+      raise ArgumentError, "other.data.size #{other.size} is not equal to data.size #{@data.size}" if other.data.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] / other.data[i]
+      end
+    elsif other.is_a?(Array)
+      raise ArgumentError, "other.size #{other.size} is not equal to data.size #{@data.size}" if other.size != @data.size
+      @data.each_index do |i|
+        new_data[i] = @data[i] / other[i]
+      end
+    else
+      raise ArgumentError, "other is not a Numeric, Signal, or Array"
+    end
+    return Signal.new(:data => new_data, :sample_rate => @sample_rate)
+  end
+
+  alias_method :+, :add
+  alias_method :-, :subtract
+  alias_method :*, :multiply
+  alias_method :/, :divide
   
   # Determine how well the another signal (g) correlates to the current signal (f).
   # Correlation is determined at every point in f. The signal g must not be

data/lib/spcore/interpolation/interpolation.rb

@@ -1,17 +1,17 @@
 module SPCore
   # Provide interpolation methods, including linear and polynomial.
 class Interpolation
-  # Linear Interpolation Equation:
-  #
-  #        (x3 - x1)(y2 - y1)
-  #  y3 =  ------------------  + y1
-  #            (x2 - x1)
-  #
-  def self.linear x1, y1, x2, y2, x3
-    y3 = ((x3 - x1) * (y2 - y1)) / (x2 - x1);
-    y3 += y1;
-    return y3;
-  end
+  ## Linear Interpolation Equation:
+  ##
+  ##        (x3 - x1)(y2 - y1)
+  ##  y3 =  ------------------  + y1
+  ##            (x2 - x1)
+  ##
+  #def self.linear x1, y1, x2, y2, x3
+  #  y3 = ((x3 - x1) * (y2 - y1)) / (x2 - x1);
+  #  y3 += y1;
+  #  return y3;
+  #end
 
   # Linear interpolator
   # Given 2 sample points, interpolates a value anywhere between the two points.

data/lib/spcore/resampling/hybrid_resampling.rb

@@ -9,7 +9,7 @@ class HybridResampling
     raise ArgumentError, "downsample_factor is not greater than 1" unless downsample_factor > 1
     raise ArgumentError, "sample_rate is not greater than 0" unless sample_rate > 0
     
-    upsampled = PolynomialResampling.upsample input, sample_rate, upsample_factor
+    upsampled = PolynomialResampling.upsample input, upsample_factor
     
     needed_samples = upsampled.size % downsample_factor
     if needed_samples == 0

data/lib/spcore/resampling/polynomial_resampling.rb

@@ -3,10 +3,9 @@ module SPCore
 # polynomial interpolation.
 class PolynomialResampling
   
-  def self.upsample input, sample_rate, upsample_factor
+  def self.upsample input, upsample_factor
     raise ArgumentError, "input.size is less than four" unless input.size >= 4
     raise ArgumentError, "upsample_factor is not greater than 1" unless upsample_factor > 1
-    raise ArgumentError, "sample_rate is not greater than 0" unless sample_rate > 0
     
     output = Array.new((upsample_factor * input.size).to_i)
     

data/lib/spcore/util/plotter.rb

@@ -33,7 +33,14 @@ class Plotter
   def plot_2d titled_hashes
     datasets = []
     titled_hashes.each do |title, hash|
-      dataset = Gnuplot::DataSet.new( [hash.keys, hash.values] ){ |ds|
+      # sort the data
+      
+      sorted = {}
+      hash.keys.sort.each do |key|
+        sorted[key] = hash[key]
+      end
+      
+      dataset = Gnuplot::DataSet.new( [sorted.keys, sorted.values] ){ |ds|
         ds.with = @linestyle
         ds.title = title
         ds.linewidth = @linewidth

data/lib/spcore/util/signal_generator.rb

@@ -35,8 +35,8 @@ class SignalGenerator
       oscs.push Oscillator.new args.merge(:frequency => freq)
     end
     
-    output = Array.new(size, 0.0)
-    size.times do |n|
+    output = Array.new(@size, 0.0)
+    @size.times do |n|
       oscs.each do |osc|
         output[n] += osc.sample
       end

data/lib/spcore/version.rb

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

data/spec/core/envelope_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPCore::Envelope do
+  it 'should produce an output that follows the amplitude of the input' do
+    sample_rate = 400
+    sample_count = sample_rate
+    generator = SignalGenerator.new(:size => sample_count, :sample_rate => sample_rate)
+    base_signal = generator.make_signal [sample_rate / 5.0]    
+    modulation_signal = generator.make_signal [sample_rate / 80.0]
+    base_signal.multiply! modulation_signal
+    
+    envelope = base_signal.envelope
+    
+    Plotter.new(
+      :title => "signal and envelope",
+      :xlabel => "sample",
+      :ylabel => "values",
+    ).plot_1d(
+      "signal" => base_signal.data,
+      "modulation" => modulation_signal.data,
+      "envelope" => envelope.data,
+    )
+    
+    max_diff = 0.1
+    sample_count.times do |n|
+      envelope.data[n].should be_within(max_diff).of(modulation_signal.data[n].abs)
+    end
+  end
+end

data/spec/core/extrema_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPCore::Extrema do
+  context '#minima' do
+    it 'should return points where local and global minima occur' do
+      cases = {
+        [3.8, 3.0, 2.9, 2.95, 3.6, 3.4, 2.8, 2.3, 2.1, 2.0, 2.5] => { 2 => 2.9, 9 => 2.0 },
+        [3.2, 3.5, 2.9, 2.7, 2.8, 2.7, 2.5, 2.2, 2.4, 2.3, 2.0] => { 3 => 2.7, 7 => 2.2, 10 => 2.0 },
+      }
+        
+      cases.each do |samples, minima|
+        Extrema.new(samples).minima.should eq minima
+      end
+    end
+  end
+  
+  context '#maxima' do
+    it 'should return points where local and global maxima occur' do
+      cases = {
+        [3.8, 3.0, 2.9, 2.95, 3.6, 3.4, 2.8, 2.3, 2.1, 2.0, 2.5] => { 0 => 3.8, 4 => 3.6 },
+        [3.2, 3.5, 2.9, 2.7, 2.8, 2.7, 2.5, 2.2, 2.4, 2.3, 2.0] => { 1 => 3.5, 4 => 2.8, 8 => 2.4},
+      }
+        
+      cases.each do |samples, maxima|
+        Extrema.new(samples).maxima.should eq maxima
+      end
+    end
+  end
+  
+  context '#extrema' do
+    it 'should return points where local and global extrema occur' do
+      cases = {
+        [3.8, 3.0, 2.9, 2.95, 3.6, 3.4, 2.8, 2.3, 2.1, 2.0, 2.5] => { 0 => 3.8, 2 => 2.9, 4 => 3.6, 9 => 2.0},
+        [3.2, 3.5, 2.9, 2.7, 2.8, 2.7, 2.5, 2.2, 2.4, 2.3, 2.0] => { 1 => 3.5, 3 => 2.7, 4 => 2.8, 7 => 2.2, 8 => 2.4, 10 => 2.0},
+      }
+        
+      cases.each do |samples, extrema|
+        Extrema.new(samples).extrema.should eq extrema
+      end
+    end
+  end
+end

data/spec/resampling/hybrid_resampling_spec.rb

@@ -8,7 +8,7 @@ describe SPCore::HybridResampling do
       sample_rate = 400
       test_freq = 10.0
       size = 64
-      upsample_factor = 4
+      upsample_factor = 10
       downsample_factor = 4
       order = (sample_rate / test_freq).to_i
       
@@ -16,7 +16,7 @@ describe SPCore::HybridResampling do
       signal1 *= BlackmanWindow.new(size).data
       signal2 = signal1.clone.resample_hybrid upsample_factor, downsample_factor, order
       
-      #plotter = Plotter.new(:title => "Discrete resampling, up by #{upsampling_factor}, down by #{downsample_factor}")
+      #plotter = Plotter.new(:title => "Discrete resampling, up by #{upsample_factor}, down by #{downsample_factor}")
       #plotter.plot_1d("original signal" => signal1.data, "resampled signal" => signal2.data)
 
       signal2.size.should eq(signal1.size * upsample_factor / downsample_factor)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spcore
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashmake
@@ -147,7 +147,8 @@ files:
 - lib/spcore/core/circular_buffer.rb
 - lib/spcore/core/constants.rb
 - lib/spcore/core/delay_line.rb
-- lib/spcore/core/envelope_detector.rb
+- lib/spcore/core/envelope.rb
+- lib/spcore/core/extrema.rb
 - lib/spcore/core/oscillator.rb
 - lib/spcore/core/signal.rb
 - lib/spcore/filters/fir/dual_sinc_filter.rb
@@ -165,6 +166,7 @@ files:
 - lib/spcore/resampling/polynomial_resampling.rb
 - lib/spcore/transforms/dft.rb
 - lib/spcore/transforms/fft.rb
+- lib/spcore/util/envelope_detector.rb
 - lib/spcore/util/gain.rb
 - lib/spcore/util/limiters.rb
 - lib/spcore/util/plotter.rb
@@ -189,7 +191,8 @@ files:
 - spcore.gemspec
 - spec/core/circular_buffer_spec.rb
 - spec/core/delay_line_spec.rb
-- spec/core/envelope_detector_spec.rb
+- spec/core/envelope_spec.rb
+- spec/core/extrema_spec.rb
 - spec/core/oscillator_spec.rb
 - spec/filters/fir/dual_sinc_filter_spec.rb
 - spec/filters/fir/sinc_filter_spec.rb
@@ -202,6 +205,7 @@ files:
 - spec/spec_helper.rb
 - spec/transforms/dft_spec.rb
 - spec/transforms/fft_spec.rb
+- spec/util/envelope_detector_spec.rb
 - spec/util/gain_spec.rb
 - spec/util/limiters_spec.rb
 - spec/util/saturate_spec.rb
@@ -222,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 407745007
+      hash: -1351761362878137001
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -231,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 407745007
+      hash: -1351761362878137001
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -241,7 +245,8 @@ summary: A library of signal processing methods and classes.
 test_files:
 - spec/core/circular_buffer_spec.rb
 - spec/core/delay_line_spec.rb
-- spec/core/envelope_detector_spec.rb
+- spec/core/envelope_spec.rb
+- spec/core/extrema_spec.rb
 - spec/core/oscillator_spec.rb
 - spec/filters/fir/dual_sinc_filter_spec.rb
 - spec/filters/fir/sinc_filter_spec.rb
@@ -254,6 +259,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/transforms/dft_spec.rb
 - spec/transforms/fft_spec.rb
+- spec/util/envelope_detector_spec.rb
 - spec/util/gain_spec.rb
 - spec/util/limiters_spec.rb
 - spec/util/saturate_spec.rb