Added colour to default plots (with heatmap) and some minor code tidying

9 files changed, 341 insertions, 65 deletions

diff --git a/examples/plotpartials.py b/examples/plotpartials.py
index c16fc1b..ef6d7ef 100644
--- a/examples/plotpartials.py
+++ b/examples/plotpartials.py
@@ -15,7 +15,7 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 import simpl
-import simpl.plot
+import matplotlib.pyplot as plt
 from scipy.io.wavfile import read
 
 input_file = '../tests/audio/flute.wav'
@@ -26,12 +26,12 @@ sample_rate = audio_in_data[0]
 # take just the first few frames
 audio = audio_in[0:4096]
 # Peak detection and partial tracking using SMS
-pd = simpl.SMSPeakDetection()
-pd.max_peaks = 20
-pd.hop_size = 147
+pd = simpl.SndObjPeakDetection()
+pd.max_peaks = 60
 peaks = pd.find_peaks(audio)
 pt = simpl.MQPartialTracking()
-pt.max_partials = 20
+pt.max_partials = 60
 partials = pt.find_partials(peaks)
 simpl.plot.plot_partials(partials)
-simpl.plot.show()
+plt.show()
+
diff --git a/examples/plotpeaks.py b/examples/plotpeaks.py
index 0132ba6..1c5769f 100644
--- a/examples/plotpeaks.py
+++ b/examples/plotpeaks.py
@@ -15,7 +15,7 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 import simpl
-import simpl.plot
+import matplotlib.pyplot as plt
 from scipy.io.wavfile import read
 
 input_file = '../tests/audio/flute.wav'
@@ -31,4 +31,5 @@ pd.max_peaks = 20
 peaks = pd.find_peaks(audio)
 # plot peaks using matplotlib
 simpl.plot.plot_peaks(peaks)
-simpl.plot.show()
+plt.show()
+
diff --git a/examples/resynth.py b/examples/resynth.py
index ae4b6ec..e551720 100644
--- a/examples/resynth.py
+++ b/examples/resynth.py
@@ -37,3 +37,4 @@ sndobj_synth = simpl.SndObjSynthesis()
 audio_out = sndobj_synth.synth(partials)
 audio_out = np.asarray(audio_out * 32768, np.int16)
 write(output_file, 44100, audio_out)
+
diff --git a/mq.py b/mq.py
index 42a4932..218ecb1 100644
--- a/mq.py
+++ b/mq.py
@@ -41,7 +41,7 @@ def TWM(peaks, f_min=0.0, f_max=3000.0, f_step=20.0):
     max_amp = max([x.amplitude for x in peaks])
 
     # remove all peaks with amplitude of less than 10% of max
-    # note: this is not in the paper, found that it improved accuracy however
+    # note: this is not in the TWM paper, found that it improved accuracy however
     peaks = [x for x in peaks if x.amplitude >= (max_amp * 0.1)]
 
     # get the max frequency of the remaining peaks
diff --git a/plot.py b/plot.py
deleted file mode 100644
index 47c3e4a..0000000
--- a/plot.py
+++ /dev/null
@@ -1,53 +0,0 @@
-# Copyright (c) 2009 John Glover, National University of Ireland, Maynooth
-# 
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of 
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-from pylab import plot, show
-
-def _plot_frame_peaks(frame, frame_number):
-    "Plot one frame, which is a list of Peak objects"
-    x_values = [frame_number for x in range(len(frame))]
-    y_values = [int(peak.frequency) for peak in frame]
-    plot(x_values, y_values, "ro")
-    
-def plot_peaks(peaks):
-    "Plot peaks found by a peak detection algorithm"
-    for frame_number, frame in enumerate(peaks):
-        _plot_frame_peaks(frame, frame_number)
-        
-def plot_frame_peaks(peaks):
-    "Plot peaks in one frame"
-    x_values = []
-    y_values = []
-    for peak in peaks:
-        x_values.append(int(peak.frequency))
-        y_values.append(peak.amplitude)
-    plot(x_values, y_values, 'ro')
-        
-def plot_partials(partials, show_peaks=True):
-    "Plot partials created by a partial tracking algorithm"
-    num_frames = max([partial.get_last_frame() for partial in partials])
-    peaks = [[] for f in range(num_frames)]
-    for partial in partials:
-        x_values = []
-        y_values = []
-        for peak_number, peak in enumerate(partial.peaks):
-            x_values.append(partial.starting_frame + peak_number)
-            y_values.append(int(peak.frequency))
-            peaks[partial.starting_frame + peak_number].append(peak)
-        plot(x_values, y_values, "b")
-    if show_peaks:
-        plot_peaks(peaks)  
-
diff --git a/plot/__init__.py b/plot/__init__.py
new file mode 100644
index 0000000..4954b07
--- /dev/null
+++ b/plot/__init__.py
@@ -0,0 +1,88 @@
+# Copyright (c) 2009 John Glover, National University of Ireland, Maynooth
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of 
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+import matplotlib.pyplot as plt
+import colours
+
+def plot_frame_peaks(peaks):
+    "Plot peaks in one frame"
+    x_values = []
+    y_values = []
+    for peak in peaks:
+        x_values.append(int(peak.frequency))
+        y_values.append(peak.amplitude)
+    plt.plot(x_values, y_values, 'ro')
+
+#def _plot_frame_peaks(frame, frame_number, max_amp=0):
+#    "Plot one frame, which is a list of Peak objects"
+#    x_values = [frame_number for x in range(len(frame))]
+#    y_values = [int(peak.frequency) for peak in frame]
+#    plt.plot(x_values, y_values, 'ro')
+
+def _plot_frame_peaks(frame, frame_number, max_amp=0):
+    "Plot one frame, which is a list of Peak objects"
+    for peak in frame:
+        plt.plot(frame_number, int(peak.frequency), linestyle="None",
+                 marker="o", markersize=2, markeredgewidth=None,
+                 markerfacecolor=colours.pbj(peak.amplitude/max_amp))
+    
+def plot_peaks(peaks):
+    "Plot peaks found by a peak detection algorithm"
+    max_amp = max([max([p.amplitude for p in f if p]) for f in peaks if f])
+    for frame_number, frame in enumerate(peaks):
+        _plot_frame_peaks(frame, frame_number, max_amp)
+        
+#def plot_partials(partials, show_peaks=True):
+#    "Plot partials created by a partial tracking algorithm"
+#    max_amp = max([max([peak.amplitude for peak in p.peaks if p.peaks])
+#                   for p in partials if p])
+#    num_frames = max([partial.get_last_frame() for partial in partials])
+
+#    peaks = [[] for f in range(num_frames)]
+#    for partial in partials:
+#        x_values = []
+#        y_values = []
+#        for peak_number, peak in enumerate(partial.peaks):
+#            x_values.append(partial.starting_frame + peak_number)
+#            y_values.append(int(peak.frequency))
+#            peaks[partial.starting_frame + peak_number].append(peak)
+#        plt.plot(x_values, y_values, "b")
+#    if show_peaks:
+#        plot_peaks(peaks)  
+
+def plot_partials(partials, show_peaks=False):
+    "Plot partials created by a partial tracking algorithm"
+    max_amp = max([max([peak.amplitude for peak in p.peaks if p.peaks])
+                   for p in partials if p])
+    num_frames = max([partial.get_last_frame() for partial in partials])
+
+    peaks = [[] for f in range(num_frames)]
+    for partial in partials:
+        x_values = []
+        y_values = []
+        avg_amp = 0.0
+        num_peaks = 0
+        for peak_number, peak in enumerate(partial.peaks):
+            x_values.append(partial.starting_frame + peak_number)
+            y_values.append(int(peak.frequency))
+            avg_amp += peak.amplitude
+            num_peaks += 1
+            peaks[partial.starting_frame + peak_number].append(peak)
+        avg_amp /= num_peaks
+        plt.plot(x_values, y_values, color=colours.pbj(avg_amp/max_amp))
+    if show_peaks:
+        plot_peaks(peaks)  
+
diff --git a/plot/colours.py b/plot/colours.py
new file mode 100644
index 0000000..b85d48d
--- /dev/null
+++ b/plot/colours.py
@@ -0,0 +1,241 @@
+# Copyright (c) 2010 John Glover, National University of Ireland, Maynooth
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of 
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+# These colour maps are based on the colour schemes in gheat:
+# http://code.google.com/p/gheat/
+
+classic_colours = [
+    [0.200, 0.200, 0.239],
+    [0.188, 0.188, 0.247],
+    [0.173, 0.173, 0.255],
+    [0.157, 0.157, 0.263],
+    [0.137, 0.137, 0.267],
+    [0.114, 0.114, 0.275],
+    [0.094, 0.094, 0.278],
+    [0.075, 0.075, 0.286],
+    [0.055, 0.055, 0.298],
+    [0.039, 0.039, 0.302],
+    [0.027, 0.027, 0.310],
+    [0.020, 0.020, 0.333],
+    [0.012, 0.016, 0.361],
+    [0.004, 0.020, 0.396],
+    [0.004, 0.031, 0.431],
+    [0.000, 0.047, 0.471],
+    [0.000, 0.071, 0.514],
+    [0.000, 0.102, 0.557],
+    [0.000, 0.137, 0.596],
+    [0.000, 0.180, 0.635],
+    [0.000, 0.227, 0.671],
+    [0.000, 0.278, 0.706],
+    [0.000, 0.337, 0.741],
+    [0.000, 0.388, 0.769],
+    [0.000, 0.439, 0.796],
+    [0.000, 0.478, 0.816],
+    [0.000, 0.545, 0.855],
+    [0.000, 0.612, 0.894],
+    [0.000, 0.678, 0.925],
+    [0.000, 0.737, 0.957],
+    [0.000, 0.792, 0.980],
+    [0.000, 0.839, 0.996],
+    [0.000, 0.878, 1.000],
+    [0.000, 0.910, 1.000],
+    [0.000, 0.918, 0.996],
+    [0.000, 0.918, 0.973],
+    [0.000, 0.918, 0.949],
+    [0.000, 0.918, 0.918],
+    [0.000, 0.918, 0.882],
+    [0.000, 0.918, 0.839],
+    [0.000, 0.906, 0.796],
+    [0.000, 0.890, 0.745],
+    [0.000, 0.871, 0.698],
+    [0.000, 0.847, 0.647],
+    [0.000, 0.835, 0.612],
+    [0.000, 0.820, 0.576],
+    [0.000, 0.804, 0.541],
+    [0.000, 0.788, 0.506],
+    [0.000, 0.776, 0.471],
+    [0.000, 0.761, 0.439],
+    [0.000, 0.749, 0.408],
+    [0.000, 0.737, 0.373],
+    [0.000, 0.729, 0.345],
+    [0.000, 0.722, 0.314],
+    [0.000, 0.714, 0.290],
+    [0.000, 0.710, 0.267],
+    [0.000, 0.706, 0.243],
+    [0.004, 0.706, 0.224],
+    [0.024, 0.710, 0.208],
+    [0.047, 0.714, 0.188],
+    [0.075, 0.722, 0.173],
+    [0.106, 0.733, 0.157],
+    [0.141, 0.745, 0.145],
+    [0.176, 0.761, 0.133],
+    [0.216, 0.776, 0.122],
+    [0.259, 0.792, 0.110],
+    [0.298, 0.812, 0.098],
+    [0.345, 0.827, 0.090],
+    [0.388, 0.847, 0.082],
+    [0.431, 0.867, 0.075],
+    [0.478, 0.886, 0.067],
+    [0.525, 0.906, 0.059],
+    [0.573, 0.925, 0.055],
+    [0.620, 0.941, 0.047],
+    [0.663, 0.957, 0.043],
+    [0.706, 0.969, 0.035],
+    [0.749, 0.984, 0.031],
+    [0.788, 0.988, 0.027],
+    [0.827, 0.988, 0.024],
+    [0.863, 0.988, 0.020],
+    [0.898, 0.988, 0.016],
+    [0.929, 0.988, 0.012],
+    [0.957, 0.988, 0.008],
+    [0.980, 0.988, 0.004],
+    [1.000, 0.984, 0.000],
+    [1.000, 0.969, 0.000],
+    [1.000, 0.949, 0.000],
+    [1.000, 0.922, 0.000],
+    [1.000, 0.890, 0.000],
+    [1.000, 0.855, 0.000],
+    [1.000, 0.816, 0.000],
+    [1.000, 0.776, 0.000],
+    [1.000, 0.733, 0.000],
+    [1.000, 0.686, 0.000],
+    [1.000, 0.639, 0.000],
+    [1.000, 0.588, 0.000],
+    [1.000, 0.537, 0.000],
+    [1.000, 0.486, 0.000],
+    [1.000, 0.435, 0.000],
+    [1.000, 0.388, 0.000]
+]
+
+pbj_colours = [
+    [0.106, 0.016, 0.267],
+    [0.110, 0.016, 0.267],
+    [0.114, 0.016, 0.263],
+    [0.114, 0.000, 0.263],
+    [0.114, 0.000, 0.263],
+    [0.122, 0.016, 0.263],
+    [0.125, 0.016, 0.263],
+    [0.125, 0.016, 0.263],
+    [0.129, 0.000, 0.259],
+    [0.129, 0.000, 0.259],
+    [0.133, 0.000, 0.259],
+    [0.137, 0.000, 0.255],
+    [0.145, 0.000, 0.259],
+    [0.149, 0.000, 0.259],
+    [0.149, 0.000, 0.255],
+    [0.153, 0.000, 0.255],
+    [0.157, 0.000, 0.251],
+    [0.161, 0.000, 0.251],
+    [0.165, 0.000, 0.251],
+    [0.165, 0.000, 0.251],
+    [0.169, 0.000, 0.247],
+    [0.176, 0.000, 0.247],
+    [0.180, 0.000, 0.243],
+    [0.184, 0.000, 0.243],
+    [0.188, 0.000, 0.243],
+    [0.196, 0.000, 0.243],
+    [0.200, 0.000, 0.239],
+    [0.204, 0.000, 0.235],
+    [0.212, 0.000, 0.235],
+    [0.216, 0.000, 0.235],
+    [0.224, 0.016, 0.231],
+    [0.227, 0.016, 0.231],
+    [0.235, 0.016, 0.227],
+    [0.235, 0.016, 0.224],
+    [0.243, 0.016, 0.220],
+    [0.247, 0.016, 0.224],
+    [0.255, 0.020, 0.220],
+    [0.263, 0.020, 0.216],
+    [0.267, 0.020, 0.212],
+    [0.278, 0.020, 0.212],
+    [0.286, 0.020, 0.208],
+    [0.290, 0.020, 0.204],
+    [0.294, 0.024, 0.200],
+    [0.302, 0.027, 0.200],
+    [0.310, 0.027, 0.196],
+    [0.318, 0.027, 0.192],
+    [0.325, 0.035, 0.188],
+    [0.333, 0.039, 0.188],
+    [0.341, 0.039, 0.180],
+    [0.349, 0.043, 0.176],
+    [0.357, 0.047, 0.173],
+    [0.365, 0.051, 0.169],
+    [0.380, 0.055, 0.165],
+    [0.384, 0.059, 0.161],
+    [0.392, 0.067, 0.157],
+    [0.404, 0.071, 0.149],
+    [0.416, 0.078, 0.149],
+    [0.427, 0.086, 0.145],
+    [0.435, 0.090, 0.137],
+    [0.443, 0.098, 0.133],
+    [0.455, 0.106, 0.129],
+    [0.471, 0.114, 0.125],
+    [0.478, 0.114, 0.122],
+    [0.486, 0.122, 0.118],
+    [0.502, 0.129, 0.114],
+    [0.510, 0.137, 0.110],
+    [0.518, 0.145, 0.106],
+    [0.525, 0.149, 0.106],
+    [0.545, 0.165, 0.102],
+    [0.549, 0.169, 0.098],
+    [0.561, 0.176, 0.094],
+    [0.569, 0.180, 0.090],
+    [0.580, 0.192, 0.090],
+    [0.592, 0.200, 0.090],
+    [0.604, 0.208, 0.086],
+    [0.612, 0.212, 0.082],
+    [0.624, 0.220, 0.082],
+    [0.635, 0.227, 0.082],
+    [0.643, 0.235, 0.078],
+    [0.651, 0.243, 0.078],
+    [0.667, 0.251, 0.078],
+    [0.675, 0.259, 0.078],
+    [0.682, 0.263, 0.078],
+    [0.686, 0.267, 0.078],
+    [0.694, 0.271, 0.078],
+    [0.706, 0.282, 0.078],
+    [0.714, 0.282, 0.078],
+    [0.722, 0.290, 0.078],
+    [0.733, 0.294, 0.082],
+    [0.741, 0.306, 0.082],
+    [0.745, 0.310, 0.082],
+    [0.753, 0.318, 0.086],
+    [0.765, 0.322, 0.086],
+    [0.773, 0.322, 0.086],
+    [0.780, 0.333, 0.090],
+    [0.784, 0.337, 0.090],
+    [0.792, 0.341, 0.090],
+    [0.800, 0.349, 0.090],
+    [0.808, 0.353, 0.090],
+    [0.820, 0.357, 0.094]
+]
+
+def classic(heat):
+    if heat < 0.0:
+        return classic_colours[0]
+    elif heat > 1.0:
+        return classic_colours[-1]
+    else:
+        return classic_colours[int(heat * (len(classic_colours)-1))]
+
+def pbj(heat):
+    if heat < 0.0:
+        return pbj_colours[0]
+    elif heat > 1.0:
+        return pbj_colours[-1]
+    else:
+        return pbj_colours[int(heat * (len(pbj_colours)-1))]
+
diff --git a/readme.txt b/readme.txt
index f684064..1e4928b 100644
--- a/readme.txt
+++ b/readme.txt
@@ -88,8 +88,6 @@ To Do
 general:
 - include new RT Audio code
 - tidy up code for HMM/LP partial tracking and Loris integration
-- label axes on plots
-- provide way to specify title and colours on plots
 - include binaries for Mac OS X and Windows so compilation from source is not needed
 - performance issues: MQ, LP and HMM algorithms need to be coded in C/C++ really,
   Python is just too slow, particularly for real-time use. The pure Python implementations
diff --git a/sms.py b/sms.py
index c22e871..661218d 100644
--- a/sms.py
+++ b/sms.py
@@ -24,7 +24,7 @@ class SMSPeakDetection(simpl.PeakDetection):
     def __init__(self):
         # limit this to only 1 instance at a time as calls to libsms are not independent,
         # some static C variables are used. These should really be addressed in libsms.
-        # todo: silently treat this as a Singleton object rather than raising an exception?
+        # TODO: silently treat this as a Singleton object rather than raising an exception?
         SMSPeakDetection._instances += 1
         if SMSPeakDetection._instances > 1:
             raise Exception("Currently only 1 instance of each SMS analysis/synthesis object can exist at once")