spcore 0.1.2 → 0.1.3

data/lib/spcore/util/signal_generator.rb

@@ -0,0 +1,48 @@
+module SPCore
+# Provides methods for generating a Signal that contains test waveforms or noise.
+class SignalGenerator
+  include Hashmake::HashMakeable
+  
+  # used to process hashed args in #initialize.
+  ARG_SPECS = [
+    Hashmake::ArgSpec.new(:key => :size, :reqd => true, :type => Fixnum, :validator => ->(a){ a > 0 }),
+    Hashmake::ArgSpec.new(:key => :sample_rate, :reqd => true, :type => Float, :validator => ->(a){ a > 0.0 })
+  ]
+  
+  attr_reader :sample_rate, :size
+  
+  # A new instance of SignalGenerator.
+  # @param [Hash] args Required keys are :sample_rate and :size.
+  def initialize args
+    hash_make ARG_SPECS, args
+  end
+  
+  # Generate a Signal object with noise data.
+  def make_noise amplitude = 1.0
+    output = Array.new(@size)
+    output.each_index do |i|
+      output[i] = rand * amplitude
+    end
+    
+    return Signal.new(:sample_rate => @sample_rate, :data => output)
+  end
+  
+  # Generate a Signal object with waveform data at the given frequencies.
+  def make_signal freqs, extra_osc_args = {}
+    args = { :sample_rate => @sample_rate }.merge! extra_osc_args
+    oscs = []
+    freqs.each do |freq|
+      oscs.push Oscillator.new args.merge(:frequency => freq)
+    end
+    
+    output = Array.new(size, 0.0)
+    size.times do |n|
+      oscs.each do |osc|
+        output[n] += osc.sample
+      end
+    end
+    
+    return Signal.new(:sample_rate => @sample_rate, :data => output)
+  end
+end
+end

data/lib/spcore/version.rb

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

data/lib/spcore/windows/bartlett_hann_window.rb

@@ -0,0 +1,15 @@
+module SPCore
+# Produces a Bartlett-Hann window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Bartlett.E2.80.93Hann_window.
+class BartlettHannWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    a0, a1, a2 = 0.62, 0.48, 0.38
+    
+    size.times do |n|
+      @data[n] = a0 - (a1 * ((n.to_f / (size - 1)) - 0.5).abs) - (a2 * Math::cos((TWO_PI * n)/(size - 1)))
+    end
+  end
+end
+end

data/lib/spcore/windows/bartlett_window.rb

@@ -0,0 +1,13 @@
+module SPCore
+# Produces a triangular window of a given size (number of samples).
+# Endpoints are zero. Midpoint is one. There is a linear slope between endpoints and midpoint.
+class BartlettWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    size.times do |n|
+      @data[n] = (2.0 / (size - 1)) * (((size - 1) / 2.0) - (n - ((size - 1) / 2.0)).abs)
+    end
+  end
+end
+end

data/lib/spcore/windows/blackman_harris_window.rb

@@ -0,0 +1,14 @@
+module SPCore
+# Produces a Blackman-Harris window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Blackman.E2.80.93Harris_window.
+class BlackmanHarrisWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    a0, a1, a2, a3 = 0.35875, 0.48829, 0.14128, 0.01168
+    size.times do |n|
+      @data[n] = a0 - a1 * Math::cos((TWO_PI * n)/(size - 1)) + a2 * Math::cos((FOUR_PI * n)/(size - 1)) - a3 * Math::cos((SIX_PI * n)/(size - 1))
+    end
+  end
+end
+end

data/lib/spcore/windows/blackman_nuttall_window.rb

@@ -0,0 +1,14 @@
+module SPCore
+# Produces a Blackman-Nuttall window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Blackman.E2.80.93Nuttall_window.
+class BlackmanNuttallWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    a0, a1, a2, a3 = 0.3635819, 0.4891775, 0.1365995, 0.0106411
+    size.times do |n|
+      @data[n] = a0 - a1 * Math::cos((TWO_PI * n)/(size - 1)) + a2 * Math::cos((FOUR_PI * n)/(size - 1)) - a3 * Math::cos((SIX_PI * n)/(size - 1))
+    end
+  end
+end
+end

data/lib/spcore/windows/blackman_window.rb

@@ -0,0 +1,18 @@
+module SPCore
+# Produces a Blackman window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Blackman_windows.
+class BlackmanWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new size
+    alpha = 0.16
+    a0 = (1 - alpha) / 2.0
+    a1 = 0.5
+    a2 = alpha / 2.0
+    
+    size.times do |n|
+      @data[n] = a0 - (a1 * Math::cos((TWO_PI * n)/(size - 1))) + (a2 * Math::cos((FOUR_PI * n)/(size - 1)))
+    end
+  end
+end
+end

data/lib/spcore/windows/cosine_window.rb

@@ -0,0 +1,13 @@
+module SPCore
+# Produces a Cosine window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Cosine_window.
+class CosineWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new size
+    size.times do |n|
+      @data[n] = Math::sin((Math::PI * n)/(size - 1))
+    end
+  end
+end
+end

data/lib/spcore/windows/flat_top_window.rb

@@ -0,0 +1,27 @@
+module SPCore
+# Produces a flat top window of a given size (number of samples).
+# A flat top window is a partially negative-valued window that has a flat top in
+# the frequency domain. They are designed to have a broader bandwidth and so have
+# a poorer frequency resolution, leading to low amplitude measurement error suitable
+# for use in in spectrum analyzers for the measurement of amplitudes of sinusoidal
+# frequency components
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Flat_top_window.
+class FlatTopWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    a0, a1, a2, a3, a4 = 1.0, 1.93, 1.29, 0.388, 0.032
+    
+    size.times do |n|
+      @data[n] = a0 - a1 * Math::cos((TWO_PI * n)/(size - 1)) + a2 * Math::cos((FOUR_PI * n)/(size - 1)) - a3 * Math::cos((SIX_PI * n)/(size - 1)) + a4 * Math::cos((EIGHT_PI * n)/(size - 1))
+    end
+    
+    max = @data.max
+    
+    # normalize to max of 1.0
+    @data.each_index do |i|
+      @data[i] /= max
+    end
+  end
+end
+end

data/lib/spcore/windows/gaussian_window.rb

@@ -0,0 +1,15 @@
+module SPCore
+# Produces a Gaussian window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Gaussian_windows.
+class GaussianWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new size
+    sigma = 0.4 # must be <= 0.5
+    size.times do |n|
+      a = (n - (size - 1) / 2) / (sigma * (size - 1) / 2)
+      @data[n] = Math::exp(-0.5 * a**2)
+    end
+  end
+end
+end

data/lib/spcore/windows/hamming_window.rb

@@ -0,0 +1,16 @@
+module SPCore
+# Produces a Hamming window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Hamming_window.
+class HammingWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new size
+    alpha = 0.54
+    beta = 1.0 - alpha
+      
+    size.times do |n|
+      @data[n] = alpha - (beta * Math::cos((TWO_PI * n) / (size - 1)))
+    end
+  end
+end
+end

data/lib/spcore/windows/hann_window.rb

@@ -0,0 +1,13 @@
+module SPCore
+# Produces a Hann window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Hann_.28Hanning.29_window.
+class HannWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    size.times do |n|
+      @data[n] = 0.5 * (1 - Math::cos((TWO_PI * n)/(size - 1)))
+    end
+  end
+end
+end

data/lib/spcore/windows/lanczos_window.rb

@@ -0,0 +1,15 @@
+module SPCore
+# Produces a Lanczos window of a given size (number of samples).
+# The Lanczos window is used in Lanczos resampling.
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Lanczos_window.
+class LanczosWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new size
+    sinc = lambda {|x| (Math::sin(Math::PI * x))/(Math::PI * x) }
+    size.times do |n|
+      @data[n] = sinc.call(((2.0*n)/(size-1)) - 1)
+    end
+  end
+end
+end

data/lib/spcore/windows/nuttall_window.rb

@@ -0,0 +1,14 @@
+module SPCore
+# Produces a Nuttall window of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Nuttall_window.2C_continuous_first_derivative.
+class NuttallWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    a0, a1, a2, a3 = 0.355768, 0.487396, 0.144232, 0.012604
+    size.times do |n|
+      @data[n] = a0 - a1 * Math::cos((TWO_PI * n)/(size - 1)) + a2 * Math::cos((FOUR_PI * n)/(size - 1)) - a3 * Math::cos((SIX_PI * n)/(size - 1))
+    end
+  end
+end
+end

data/lib/spcore/windows/rectangular_window.rb

@@ -0,0 +1,10 @@
+module SPCore
+# Produces a rectangular window (all ones) of a given size (number of samples).
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Rectangular_window.
+class RectangularWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size, 1.0)
+  end
+end
+end

data/lib/spcore/windows/triangular_window.rb

@@ -0,0 +1,14 @@
+module SPCore
+# Produces a triangular window of a given size (number of samples).
+# Endpoints are near zero. Midpoint is one. There is a linear slope between endpoints and midpoint.
+# For more info, see https://en.wikipedia.org/wiki/Window_function#Triangular_window
+class TriangularWindow
+  attr_reader :data
+  def initialize size
+    @data = Array.new(size)
+    size.times do |n|
+      @data[n] = (2.0 / (size + 1)) * (((size + 1) / 2.0) - (n - ((size - 1) / 2.0)).abs)
+    end
+  end
+end
+end

data/spcore.gemspec

@@ -5,15 +5,23 @@ require File.expand_path('../lib/spcore/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.name          = "spcore"
   gem.version       = SPCore::VERSION
-  gem.summary       = %q{Perform basic signal processing functions (delay line, filters, envelope detection, etc...).}
+  gem.summary       = %q{A library of signal processing methods and classes.}
   gem.description   = <<DESCRIPTION
-Contains core signal processing functions, including:
+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
-  Linear interpolation
   Oscillator with selectable wave type (sine, square, triangle, sawtooth)
+  Signal abstraction class.
 
 DESCRIPTION
   gem.license       = "MIT"

data/spec/{lib → core}/delay_line_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe SPCore::DelayLine do
   it 'should' do
-    SAMPLE_RATE = 44100.0
+    SAMPLE_RATE = 400.0
     MAX_DELAY_SEC = 0.1
     
     5.times do

data/spec/{lib → core}/envelope_detector_spec.rb

@@ -3,8 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe SPCore::EnvelopeDetector do
   describe '#process_sample' do
     it 'should produce an output that follows the amplitude of the input' do
-      sample_rate = 10000.0
-      freqs = [20.0, 200.0, 2000.0]
+      sample_rate = 400.0
+      freqs = [20.0, 60.0]
 
       envelope_start = 1.0
       envelope_end = 0.0
@@ -26,7 +26,7 @@ describe SPCore::EnvelopeDetector do
         sample_count = (5.0 * sample_rate / freq).to_i
         sample_count.times do |n|
           percent = n.to_f / sample_count
-          amplitude = SPCore::Interpolation.linear 0.0, envelope_start, 1.0, envelope_end, percent
+          amplitude = SPCore::Interpolation.linear envelope_start, envelope_end, percent
           osc.amplitude = amplitude
           
           sample = osc.sample

data/spec/filters/fir/dual_sinc_filter_spec.rb

@@ -0,0 +1,64 @@
+require 'pry'
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe SPCore::SincFilter do
+  before :all do
+    @sample_rate = 4000.0
+    @orders = [62]
+    @left_cutoffs = Scale.exponential 300.0..1500.0, 3
+    @right_cutoffs = Scale.exponential 400.0..1600.0, 3
+  end
+  
+  context '.bandpass' do
+    it 'should keep magnitude below -20 dB below left cutoff and above right cutoff, and close to 0 dB between' do
+      @orders.each do |order|
+        @left_cutoffs.each_index do |i|
+          left_cutoff = @left_cutoffs[i]
+          right_cutoff = @right_cutoffs[i]
+          
+          if order % 2 == 1
+            order += 1
+          end
+          filter = DualSincFilter.new :order => order, :left_cutoff_freq => left_cutoff, :right_cutoff_freq => right_cutoff, :sample_rate => @sample_rate, :window_class => BlackmanWindow
+          #filter.bandpass_fir.plot_freq_response false
+          freq_response = filter.bandpass_fir.freq_response true
+          
+          freq_response.each do |freq, magnitude|
+            if freq <= (0.8 * left_cutoff) || freq >= (1.2 * right_cutoff)
+              magnitude.should be < -20.0 # using dB
+            elsif freq.between?(1.2 * left_cutoff, 0.8 * right_cutoff)
+              magnitude.should be_within(1.0).of(0.0) # using dB
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  context '.bandstop' do
+    it 'should keep magnitude close to 0 dB below left cutoff and above right cutoff, and below -20 dB between' do
+      @orders.each do |order|
+        @left_cutoffs.each_index do |i|
+          left_cutoff = @left_cutoffs[i]
+          right_cutoff = @right_cutoffs[i]
+          
+          if order % 2 == 1
+            order += 1
+          end
+          filter = DualSincFilter.new :order => order, :left_cutoff_freq => left_cutoff, :right_cutoff_freq => right_cutoff, :sample_rate => @sample_rate, :window_class => BlackmanWindow
+          #filter.bandstop_fir.plot_freq_response false
+          freq_response = filter.bandstop_fir.freq_response true
+          
+          freq_response.each do |freq, magnitude|
+            if freq <= (0.8 * left_cutoff) || freq >= (1.2 * right_cutoff)
+              magnitude.should be_within(1.0).of(0.0) # using dB
+            elsif freq.between?(1.2 * left_cutoff, 0.8 * right_cutoff)
+              magnitude.should be < -20.0 # using dB
+            end
+          end
+        end
+      end
+    end
+  end
+  
+end

data/spec/filters/fir/sinc_filter_spec.rb

@@ -0,0 +1,57 @@
+require 'pry'
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe SPCore::SincFilter do
+  before :all do
+    @sample_rate = 4000.0
+    @orders = [62]
+    @cutoffs = Scale.exponential 400.0..1600.0, 3
+  end
+  
+  context '.highpass' do
+    it 'should keep magnitude below-20 dB below cutoff and close to 0 dB above cutoff' do
+      @orders.each do |order|
+        @cutoffs.each do |cutoff|
+          if order % 2 == 1
+            order += 1
+          end
+          filter = SincFilter.new :order => order, :cutoff_freq => cutoff, :sample_rate => @sample_rate, :window_class => BlackmanWindow
+          #filter.highpass_fir.plot_freq_response false
+          freq_response = filter.highpass_fir.freq_response true
+          
+          freq_response.each do |freq, magnitude|
+            if freq <= (0.8 * cutoff)
+              magnitude.should be < -20.0 # using dB
+            elsif freq >= (1.2 * cutoff)
+              magnitude.should be_within(1.0).of(0.0) # using dB
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  context '.lowpass' do
+    it 'should keep magnitude close to 0 dB below cutoff and below-20 dB above cutoff' do
+      @orders.each do |order|
+        @cutoffs.each do |cutoff|
+          if order % 2 == 1
+            order += 1
+          end
+          filter = SincFilter.new :order => order, :cutoff_freq => cutoff, :sample_rate => @sample_rate, :window_class => BlackmanWindow
+          #filter.lowpass_fir.plot_freq_response false
+          freq_response = filter.lowpass_fir.freq_response true
+          
+          freq_response.each do |freq, magnitude|
+            if freq <= (0.8 * cutoff)
+              magnitude.should be_within(1.0).of(0.0) # using dB
+            elsif freq >= (1.2 * cutoff)
+              magnitude.should be < -20.0 # using dB
+            end
+          end
+        end
+      end
+    end
+  end
+
+end