spectralfilter 0.0.1

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2009, Ralf Mueller (stark.dreamdetective@googlemail.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+    * The names of its contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/gemspec

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  s.name         = "spectralfilter"
+  s.version      = "0.0.1"
+  s.author       = "Ralf M�ller"
+  s.email        = "stark.dreamdetective@gmail.com"
+  s.homepage     = "http://rubyforge.org/projects/extcsv"
+  s.platform     = Gem::Platform::RUBY
+  s.summary      = "Filtering Datasets via Highpass, Lowpass, Bandpass or Bandblock"
+  candidates     = Dir.glob("lib/*.rb") + [ "rakefile", "gemspec","LICENSE"]
+  s.files        = candidates.delete_if do |item|
+                     item.include?("pkg") || item.include?("www") || item.include?("rdoc")
+                   end
+  s.require_path = "lib"
+  s.test_files   = Dir.glob("test/test_*.rb")
+  s.has_rdoc     = true
+end
+
+# vim:ft=ruby

data/lib/spectralfilter.rb

@@ -0,0 +1,73 @@
+require 'rbgsl'
+require 'mathn'
+
+class SpectralFilter
+  attr_accessor :x,:y,:fft,:sampling
+
+  # x and y can be Arrays of Floats or GSL:Vectors. The sampling attribute
+  # should be checked and changed carefully if necessary.
+  def initialize(x, y)
+    @x, @y    = [x,y].collect {|v| v.kind_of?(Array) ? GSL::Vector.alloc(v) : v}
+    @sampling = ((@x[-1]-@x[0])/@x.size)**(-1)
+    @fft      = @y.fft
+  end
+
+  # Frequences larger than freq are omitted
+  def lowpass(freq)
+    n=@y.size
+    (0...n).each {|i| @fft[i] = 0 if i*(0.5/(n*(@x[1]-@x[0]))) > freq}
+  end
+
+  # Frequences smaller than freq are omitted
+  def highpass(freq)
+    n=@y.size
+    (0...n).each {|i| @fft[i] = 0 if i*(0.5/(n*(@x[1]-@x[0]))) < freq}
+  end
+
+  # Frequences outside the range between freqMin and freqMax are subpressed
+  def bandpass(freqMin,freqMax)
+    n=@y.size
+    (0...n).each {|i| 
+      freq_   = i*(0.5/(n*(@x[1]-@x[0])))
+      @fft[i] = 0 if (freq_ < freqMin or freq_ > freqMax)
+    }
+  end
+
+  # Frequences in the range between freqMin and freqMax are omitted
+  def bandblock(freqMin,freqMax)
+    n=@y.size
+    (0...n).each {|i| 
+      freq_   = i*(0.5/(n*(@x[1]-@x[0])))
+      @fft[i] = 0 if !(freq_ < freqMin or freq_ > freqMax)
+    }
+  end
+
+  # reset the FFT to the initial state
+  def renew
+    @fft = @y.fft
+  end
+
+  # Display the spectrum
+  def plotSpec(opts="-C -g 3 -x 0 #{@sampling/2} -X 'Frequency [Hz]'")
+    mag, phase, frq = proc4plot
+    GSL::graph(frq, mag, opts)
+  end
+
+  # Display Datasets before and aftern Filtering
+  def plotData(opts="-C -g 3")
+    GSL::graph(@x,@y,           opts  + " -L 'Original Data'")
+    GSL::graph(@x,@fft.inverse, opts + " -L 'After Filtering'")
+  end
+
+  # little helper method for plotting
+  def proc4plot
+    y     = @fft.subvector(1, @y.size-2).to_complex2
+    mag   = y.abs
+    phase = y.arg
+    frq   = GSL::Vector.linspace(0, @sampling/2, mag.size)
+    [mag,phase,frq]
+  end
+
+  private :proc4plot
+end
+

data/rakefile

@@ -0,0 +1,96 @@
+begin	
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+SPEC = eval(File.open("gemspec","r").read)
+
+def filename_to_sym(filename)
+  File.basename(filename,File.extname(filename)).to_sym
+end
+
+# ====================================================================
+# TEST TASKS
+test_tasks = {
+  :test_all   => ["Run all tests"],
+}
+# Syntax checkning task
+task :test_syn do
+  Dir.glob("**/*.rb").each {|file|
+    printf "Checking Syntax of #{file} ..."
+    system("ruby -c #{file}")
+  }
+end
+# Test tasks for each test file
+SPEC.test_files.each do |test_file|
+  next unless File.extname(test_file) == ".rb"
+  Rake::TestTask.new(filename_to_sym(test_file)) do |t|
+    test_tasks[:test_all]  << filename_to_sym(test_file)
+    t.test_files = FileList[test_file]
+    t.warning = false
+    t.verbose = true
+  end
+end
+
+# Test Tasks for groups of test files
+test_tasks.each do |k,v|
+  desc  v[0]
+  task k => v[1..-1]
+end
+# ====================================================================
+# Create a task that will package the software into distributable
+# tar, zip and gem files.
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  package_task = Rake::GemPackageTask.new(SPEC) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+# ====================================================================
+desc "Install the Library with docs"
+task :install => [:repackage] do
+  command = "gem install pkg/#{SPEC.name}-#{SPEC.version}.gem"
+  puts command
+  system(command)
+end
+task :smallInstall => [:repackage] do 
+  command = "gem install pkg/#{SPEC.name}-#{SPEC.version}.gem --no-ri --no-rdoc"
+  puts command
+  system(command)
+end
+# ====================================================================
+# Create a task to build the RDOC documentation tree.
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "Spectral Filtering of datasets through fft-functionality of rb-gsl"
+  rdoc.options << '-ad' << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+}
+############################################################
+files       = Dir.glob("{lib,test}/*.rb")
+visual_mode = (ENV["vimode"].nil?) ? '-p' : ENV["vimode"]
+desc "Edit texfiles #{files.join(", ")}"
+task :edit do
+  com = (File.exist?("Session.vim"))\
+    ? 'vim -S'\
+    : "vim #{files.join(" ")} rakefile gemspec #{visual_mode}"
+  puts com
+  system(com)
+end
+############################################################
+desc "renew the tags file"
+task :tags do
+  com = "rtags --vi -f tags lib/*.rb"
+  system(com)
+end
+#
+#
+# vim:ft=ruby
+#

data/test/test_spectralfilter.rb

@@ -0,0 +1,35 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require 'test/unit'
+require 'spectralfilter'
+
+class TestSpectralFilter < Test::Unit::TestCase
+  N = 2048
+  SAMPLING = 2000   # 2 kHz
+  TMAX = 1.0/SAMPLING*N
+  FREQ1 = 50
+  FREQ2 = 120
+  FREQ3 = 500
+  FREQ4 = 550
+  def test_simple
+    t = GSL::Vector.linspace(0, TMAX, N)
+    x = GSL::Sf::sin(2*Math::PI*FREQ1*t) + \
+        GSL::Sf::sin(2*Math::PI*FREQ2*t) + \
+        GSL::Sf::sin(2*Math::PI*FREQ3*t) + \
+        GSL::Sf::sin(2*Math::PI*FREQ4*t)
+
+    sf = SpectralFilter.new(t,x)
+    opts ="-C -g 3 -x 0 700 "
+    sf.plotSpec(opts + "-L'Original Data'")
+    sf.lowpass(60)
+    sf.plotSpec(opts + "-L 'lowpass(60)'")
+    sf.renew
+    sf.highpass(450)
+    sf.plotSpec(opts + "-L 'highpass(450)'")
+    sf.renew
+    sf.bandpass(100,520)
+    sf.plotSpec(opts + "-L 'bandpass(100,520)'")
+    sf.renew
+    sf.bandblock(100,520)
+    sf.plotSpec(opts + "-L 'bandblock(100,520)'")
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: spectralfilter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Ralf M\xFCller"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-24 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: stark.dreamdetective@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/spectralfilter.rb
+- rakefile
+- gemspec
+- LICENSE
+has_rdoc: true
+homepage: http://rubyforge.org/projects/extcsv
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Filtering Datasets via Highpass, Lowpass, Bandpass or Bandblock
+test_files: 
+- test/test_spectralfilter.rb