doc

Author: Chen Xie

README.md

@@ -12,7 +12,7 @@
 <ul>
 	<li>15 July 2016 - <code>rdsamp</code> (for reading WFDB signals) is ready for beta usage.</li>
 	<li>27 July 2016 - <code>rdann</code> (for reading WFDB annotations) is ready for beta usage.</li>
-	<li>27 July 2016 - <code>plotsigs</code> is able to plot signals and annotations output by <em>rdsamp</em> and <em>rdann</em></li>
+	<li>27 July 2016 - <code>plotwfdb</code> is able to plot signals and annotations output by <em>rdsamp</em> and <em>rdann</em></li>
 </ul>
 
 
@@ -87,14 +87,13 @@ Output arguments:
 
 ### Plotting Data
 
-<strong>plotsigs</strong> - Subplot and label each channel of an nxm signal on a graph. Also subplot annotation locations on selected channels if present.  
+<strong>plotwfdb</strong> - Subplot and label each channel of an nxm signal on a graph. Also subplot annotation locations on selected channels if present.  
 
 ```
 import wfdb
-from wfdb import plotwfdb
 sig, fields = wfdb.rdsamp(recordname)
 annsamp=wfdb.rdann('recordname', 'annot')[0]
-plotwfdb.plotsigs(sig, fields, annsamp, annch, title, plottime): 
+wfdb.plotwfdb(sig, fields, annsamp, annch, title, plottime): 
  
 ```
 

sampledata/README.md

@@ -1,2 +1,3 @@
 from ._rdsamp import rdsamp
-from ._rdann import rdann
+from ._rdann import rdann
+from ._plotwfdb import plotwfdb

wfdb/__init__.py

@@ -2,7 +2,7 @@
 import matplotlib.pyplot as plt
 
 
-def plotsigs(sig, fields, annsamp=[], annch=[0], title=[], plottime=1): 
+def plotwfdb(sig, fields, annsamp=[], annch=[0], title=[], plottime=1): 
     """ Subplot and label each channel of a WFDB signal. Also subplot annotation locations on selected channels if present.  
     
     Usage: plotsigs(sig, fields, annsamp=[], annch=[0], title=[], plottime=1): 
@@ -58,4 +58,6 @@ def plotsigs(sig, fields, annsamp=[], annch=[0], title=[], plottime=1):
         plt.ylabel(chanlabel+"/"+unitlabel)
 
     plt.show(f1)
-       
+    
+if __name__ == '__main__':
+    plotwfdb(sys.argv)

wfdb/plotwfdb.py renamed to wfdb/_plotwfdb.py

@@ -15,10 +15,7 @@
    },
    "outputs": [],
    "source": [
-    "import numpy as np\n",
-    "from wfdb import readsignal\n",
-    "from wfdb import readannot\n",
-    "from wfdb import plotwfdb\n",
+    "import wfdb\n",
     "%matplotlib inline"
    ]
   },
@@ -32,8 +29,8 @@
    "source": [
     "# Demo 1 - Read the wfdb file, plot the last part of the signals, and print the metadata\n",
     "\n",
-    "sig, fields=readsignal.rdsamp('sampledata/a103l') \n",
-    "plotwfdb.plotsigs(sig[80000:,:], fields, title='Record a103l from Physionet Challenge 2015') \n",
+    "sig, fields=wfdb.rdsamp('sampledata/a103l') \n",
+    "wfdb.plotwfdb(sig[80000:,:], fields, title='Record a103l from Physionet Challenge 2015') \n",
     "fields"
    ]
   },
@@ -47,8 +44,8 @@
    "source": [
     "# Demo 2 - Read certain channels and sections of the WFDB file and plot them. \n",
     "\n",
-    "sig, fields=readsignal.rdsamp('sampledata/s0010_re', channels=[14, 0, 5, 10, 11], sampfrom=100, sampto=15000)\n",
-    "plotwfdb.plotsigs(sig, fields)"
+    "sig, fields=wfdb.rdsamp('sampledata/s0010_re', channels=[14, 0, 5, 10, 11], sampfrom=100, sampto=15000)\n",
+    "wfdb.plotwfdb(sig, fields)"
    ]
   },
   {
@@ -61,9 +58,9 @@
    "source": [
     "# Demo 3 - Read the WFDB signal and annotation file and plot them together.\n",
     "\n",
-    "sig, fields=readsignal.rdsamp('sampledata/100')\n",
-    "annsamp=readannot.rdann('sampledata/100', 'atr')[0]\n",
-    "plotwfdb.plotsigs(sig, fields, annsamp=annsamp, annch=[0], title='Record 100 from MIT-BIH Arrhythmia Database')"
+    "sig, fields=wfdb.rdsamp('sampledata/100')\n",
+    "annsamp=wfdb.rdann('sampledata/100', 'atr')[0]\n",
+    "wfdb.plotwfdb(sig, fields, annsamp=annsamp, annch=[0], title='Record 100 from MIT-BIH Arrhythmia Database')"
    ]
   },
   {
@@ -74,7 +71,7 @@
     "\n",
     "The following sections load and plots waveforms from the MIMIC matched waveform database. These waveforms have been matched to clinical data in the MIMIC Clinical database. The input records are multi-segment (made up of multiple individual WFDB records) and relatively long.\n",
     "\n",
-    "Note that in these kinds of records there are segments in which certain channels are missing. <strong>matplotlib</strong> automatically zooms in on sections without Nans in individual channels but the entire durations of the signals input into <strong>plotsigs</strong> are actually plotted. \n",
+    "Note that these kinds of records contain segments in which certain channels are missing. <strong>matplotlib</strong> automatically zooms in on sections without Nans in individual channels but the entire durations of the signals input into <strong>plotwfdb</strong> are actually plotted. \n",
     "\n"
    ]
   },
@@ -87,8 +84,8 @@
    "outputs": [],
    "source": [
     "# Demo 4 - Read the multi-segment signal and plot waveforms from the MIMIC matched waveform database. \n",
-    "sig, fields=readsignal.rdsamp('sampledata/matched/s25047/s25047-2704-05-04-10-44')\n",
-    "plotwfdb.plotsigs(sig, fields, title='s25047/s25047-2704-05-04-10-44') \n",
+    "sig, fields=wfdb.rdsamp('sampledata/matched/s25047/s25047-2704-05-04-10-44')\n",
+    "wfdb.plotwfdb(sig, fields, title='s25047/s25047-2704-05-04-10-44') \n",
     "fields"
    ]
   },
@@ -101,9 +98,9 @@
    "outputs": [],
    "source": [
     "# Demo 5 - Read the multi-segment signal and plot waveforms from the MIMIC matched waveform database. \n",
-    "sig, fields=readsignal.rdsamp('sampledata/matched/s00001/s00001-2896-10-10-00-31')\n",
+    "sig, fields=wfdb.rdsamp('sampledata/matched/s00001/s00001-2896-10-10-00-31')\n",
     "# Note, very long record to plot. \n",
-    "plotwfdb.plotsigs(sig[240000:, :], fields, title='s00001/s00001-2896-10-10-00-31') \n",
+    "wfdb.plotwfdb(sig[240000:, :], fields, title='s00001/s00001-2896-10-10-00-31') \n",
     "fields"
    ]
   },
@@ -133,7 +130,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.1"
+   "version": "3.5.2"
   }
  },
  "nbformat": 4,