fix examples

cx1111 · cx1111 · commit d7a7cbb3c86d · 2017-10-03T13:21:11.000-04:00
diff --git a/README.rst b/README.rst
@@ -735,26 +735,6 @@ See code comments for details about the algorithm.
 
   correct_peaks(x, peak_indices, min_gap, max_gap, smooth_window)
 
-Example Usage:
-
-::
-
-    import wfdb
-    t0 = 10000
-    tf = 20000
-    sig, fields = wfdb.srdsamp('sampledata/100', sampfrom=t0, sampto=tf, channels=[0])
-    record = wfdb.rdsamp("sampledata/100", sampfrom=t0, sampto=tf, channels=[0], physical=False)
-    peak_indices = wfdb.processing.gqrs_detect(x=sig[:,0], frequency=fields['fs'], 
-                                               adcgain=record.adcgain[0], adczero=record.adczero[0],
-                                               threshold=1.0)
-    fs = fields['fs']
-    min_bpm = 10
-    max_bpm = 350
-    min_gap = fs*60/min_bpm
-    max_gap = fs*60/max_bpm
-    new_indices = wfdb.processing.correct_peaks(x=sig[:,0], peak_indices=peak_indices,
-                                                min_gap=min_gap, max_gap=max_gap, smooth_window=150)
-
 Input arguments:
 
 - ``x`` (required): The signal.
@@ -768,6 +748,28 @@ Output Arguments:
 - ``new_indices``: A python list containing the new peaks indices.
 
 
+Example Usage:
+
+::
+
+    import wfdb
+    t0 = 10000
+    tf = 20000
+    record = wfdb.rdsamp('sampledata/100', sampfrom=t0, sampto=tf, channels=[0])
+    d_signal = record.adc()[:,0]
+    peak_indices = wfdb.processing.gqrs_detect(d_signal, fs=record.fs, 
+                                               adcgain=record.adcgain[0], 
+                                               adczero=record.adczero[0],
+                                               threshold=1.0)
+    min_bpm = 10
+    max_bpm = 350
+    min_gap = record.fs*60/min_bpm
+    max_gap = record.fs*60/max_bpm
+    new_indices = wfdb.processing.correct_peaks(d_signal, peak_indices=peak_indices,
+                                                min_gap=min_gap, max_gap=max_gap, 
+                                                smooth_window=150)
+
+
 Heart Rate
 ~~~~~~~~~~~~~~
 
@@ -777,18 +779,6 @@ Heart Rate
 
   compute_hr(siglen, peak_indices, fs)
 
-Example Usage:
-
-::
-
-    import wfdb
-    t0 = 10000
-    tf = 20000
-    sig, fields = wfdb.srdsamp('sampledata/100', sampfrom=t0, sampto=tf, channels=[0])
-    record = wfdb.rdsamp("sampledata/100", sampfrom=t0, sampto=tf, channels=[0], physical=False)
-    peak_indices = wfdb.processing.gqrs_detect(x=sig[:,0], frequency=fields['fs'], adcgain=record.adcgain[0], adczero=record.adczero[0], threshold=1.0)
-    hr = compute_hr(siglen=tf-t0, peak_indices=peak_indices, fs=fields['fs'])
-
 Input arguments:
 
 - ``siglen`` (required): The length of the corresponding signal.
@@ -801,6 +791,22 @@ Output Arguments:
 - ``hr``: A numpy array of the instantaneous heart rate, with the length of the corresponding signal. Contains numpy.nan where heart rate could not be computed.
 
 
+Example Usage:
+
+::
+
+    import wfdb
+    t0 = 10000
+    tf = 20000
+    record = wfdb.rdsamp("sampledata/100", sampfrom=t0, sampto=tf, channels=[0])
+    peak_indices = wfdb.processing.gqrs_detect(record.adc(), fs=record.fs,
+                                               adcgain=record.adcgain[0],
+                                               adczero=record.adczero[0],
+                                               threshold=1.0)
+    hr = wfdb.processing.compute_hr(siglen=tf-t0, peak_indices=peak_indices, fs=record.fs)
+
+
+
 
 Based on the original WFDB software package specifications
 ----------------------------------------------------------
diff --git a/demo.ipynb b/demo.ipynb
@@ -445,7 +445,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "collapsed": true
+   },
    "outputs": [],
    "source": [
     "def peaks_hr(x, peak_indices, fs, title, figsize=(20, 10), saveto=None):\n",
@@ -488,7 +490,7 @@
     "    print('gqrs detected peak indices:', peak_indices)\n",
     "    peaks_hr(x=record.p_signals, peak_indices=peak_indices, fs=record.fs, title=\"GQRS peak detection on sampledata/100\")\n",
     "    \n",
-    "    # Do peak detection with constraints\n",
+    "    # Correct the peaks by applying constraints\n",
     "    min_bpm = 20\n",
     "    max_bpm = 230\n",
     "    min_gap = record.fs*60/min_bpm\n",
