add symbol plotting option to plotrec for annotations. fixes MIT-LCP#78

cx1111 · cx1111 · commit 13f5595e0440 · 2017-12-07T18:18:19.000-05:00
diff --git a/README.rst b/README.rst
@@ -439,7 +439,8 @@ Plotting Data
 ::
 
     plotrec(record=None, title = None, annotation = None, timeunits='samples',
-            sigstyle='', figsize=None, returnfig = False, ecggrids=[]):
+            sigstyle='', annstyle='r*', plotannsym=False, figsize=None,
+            returnfig=False, ecggrids=[]): 
 
 Example Usage:
 
@@ -461,6 +462,7 @@ Input Arguments:
 - ``timeunits`` (default='samples'): String specifying the x axis unit. Allowed options are: 'samples', 'seconds', 'minutes', and 'hours'.
 - ``sigstyle`` (default=''): String, or list of strings, specifying the styling of the matplotlib plot for the signals. If 'sigstyle' is a string, each channel will have the same style. If it is a list, each channel's style will correspond to the list element. ie. sigtype=['r','b','k'].
 - ``annstyle`` (default='r*'): String, or list of strings, specifying the styling of the matplotlib plot for the annotations. If 'annstyle' is a string, each channel will have the same style. If it is a list, each channel's style will correspond to the list element.
+- ``plotannsym`` (default=False): Specifies whether to plot the annotation symbols at their locations.
 - ``figsize`` (default=None): Tuple pair specifying the width, and height of the figure. Same as the 'figsize' argument passed into matplotlib.pyplot's figure() function.
 - ``returnfig`` (default=False): Specifies whether the figure is to be returned as an output argument
 - ``ecggrids`` (default=[]): List of integers specifying channels in which to plot ecg grids. May be set to [] for no channels, or 'all' for all channels. Major grids at 0.5mV, and minor grids at 0.125mV. All channels to be plotted with grids must have units equal to 'uV', 'mV', or 'V'.
diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@
     # Versions should comply with PEP440. For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='1.3.4',
+    version='1.3.6',
 
     description='The WFDB Python Toolbox',
     long_description=long_description,
diff --git a/wfdb/plot/plots.py b/wfdb/plot/plots.py
@@ -8,7 +8,8 @@
 
 # Plot a WFDB Record's signals
 # Optionally, overlay annotation locations
-def plotrec(record=None, title = None, annotation = None, timeunits='samples', sigstyle='', annstyle='r*', figsize=None, returnfig = False, ecggrids=[]): 
+def plotrec(record=None, title=None, annotation=None, timeunits='samples',
+    sigstyle='', annstyle='r*', plotannsym=False, figsize=None, returnfig=False, ecggrids=[]): 
     """ Subplot and label each channel of a WFDB Record.
     Optionally, subplot annotation locations over selected channels.
     
@@ -32,6 +33,7 @@ def plotrec(record=None, title = None, annotation = None, timeunits='samples', s
     - annstyle (default='r*'): String, or list of strings, specifying the styling of the matplotlib plot for the annotations.
       If 'annstyle' is a string, each channel will have the same style. If it is a list, each channel's style will 
       correspond to the list element.
+    - plotannsym (default=False): Specifies whether to plot the annotation symbols at their locations.
     - figsize (default=None): Tuple pair specifying the width, and height of the figure. Same as the 'figsize' argument
       passed into matplotlib.pyplot's figure() function.
     - returnfig (default=False): Specifies whether the figure is to be returned as an output argument
@@ -87,6 +89,10 @@ def plotrec(record=None, title = None, annotation = None, timeunits='samples', s
         # Plot annotation if specified
         if annplot[ch] is not None:
             ax.plot(tann[ch], record.p_signals[annplot[ch], ch], annstyle[ch])
+            # Plot the annotation symbols if specified
+            if plotannsym:
+                for i, s in enumerate(annotation.symbol):
+                    ax.annotate(s, (tann[ch][i], record.p_signals[annplot[ch], ch][i]))
 
         # Axis Labels
         if timeunits == 'samples':
