Skip to content

Commit 33bcfc7

Browse files
committed
fix readme
1 parent 45b8188 commit 33bcfc7

File tree

1 file changed

+7
-21
lines changed

1 file changed

+7
-21
lines changed

README.rst

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,7 @@ When reading signal sample values into ``record`` objects using ``rdsamp``, the
216216
One can also use existing objects to obtain physical values from digital values and vice versa, without having to re-read the wfdb file with a different set of options. The two following instance methods perform the conversions.
217217

218218

219-
**adc** - Performs analogue to digital conversion of the physical signal stored
220-
in p_signals if expanded is False, or e_p_signals if expanded is True.
221-
222-
The p_signals/e_p_signals, fmt, gain, and baseline fields must all be
223-
valid.
224-
225-
If inplace is True, the adc will be performed inplace on the variable,
226-
the d_signals/e_d_signals attribute will be set, and the
227-
p_signals/e_p_signals field will be set to None.
219+
**adc** - Performs analogue to digital conversion of the physical signal stored in p_signals if expanded is False, or e_p_signals if expanded is True. The p_signals/e_p_signals, fmt, gain, and baseline fields must all be valid. If inplace is True, the adc will be performed inplace on the variable, the d_signals/e_d_signals attribute will be set, and the p_signals/e_p_signals field will be set to None.
228220

229221
::
230222

@@ -241,23 +233,16 @@ Possible output argument:
241233

242234
Example Usage:
243235

244-
::
236+
::
237+
245238
import wfdb
246239
record = wfdb.rdsamp('sampledata/100')
247240
d_signal = record.adc()
248241
record.adc(inplace=True)
249242
record.dac(inplace=True)
250243

251244

252-
**dac** - Performs digital to analogue conversion of the digital signal stored
253-
in d_signals if expanded is False, or e_d_signals if expanded is True.
254-
255-
The d_signals/e_d_signals, fmt, gain, and baseline fields must all be
256-
valid.
257-
258-
If inplace is True, the dac will be performed inplace on the variable,
259-
the p_signals/e_p_signals attribute will be set, and the
260-
d_signals/e_d_signals field will be set to None.
245+
**dac** - Performs digital to analogue conversion of the digital signal stored in d_signals if expanded is False, or e_d_signals if expanded is True. The d_signals/e_d_signals, fmt, gain, and baseline fields must all be valid. If inplace is True, the dac will be performed inplace on the variable, the p_signals/e_p_signals attribute will be set, and the d_signals/e_d_signals field will be set to None.
261246

262247
::
263248

@@ -274,7 +259,8 @@ Possible output argument:
274259

275260
Example Usage:
276261

277-
::
262+
::
263+
278264
import wfdb
279265
record = wfdb.rdsamp('sampledata/100', physical=False)
280266
p_signal = record.dac()
@@ -344,7 +330,7 @@ Example Usage:
344330
import wfdb
345331
ann = wfdb.rdann('sampledata/100', 'atr', sampto = 300000)
346332

347-
Input arguments:
333+
Input Arguments:
348334

349335
- ``recordname`` (required): The record name of the WFDB annotation file. ie. for file `100.atr`, recordname='100'
350336
- ``extension`` (required): The annotatator extension of the annotation file. ie. for

0 commit comments

Comments
 (0)