Skip to content

Commit 64f1dbc

Browse files
committed
Update readme
Still needs a lot of work, but at least incorrect information has been removed.
1 parent eaa8323 commit 64f1dbc

File tree

1 file changed

+9
-59
lines changed

1 file changed

+9
-59
lines changed

README.rst

+9-59
Original file line numberDiff line numberDiff line change
@@ -6,47 +6,9 @@ in the waveform.
66

77
The default input/output format used by the program are designed to work with
88
the in-house file format used by Eaton Peabody Laboratory. Refer to the
9-
peakdetect.py file for documentation on how to adapt this program to your data
9+
parsers directory for documentation on how to adapt this program to your data
1010
format.
1111

12-
Loading Data
13-
------------
14-
Data can be loaded by opening a file directly via the command line ("python
15-
analyze.py CAP-139-5"), dragging and dropping the file from the operating system
16-
desktop, or selecting it via the file menu. Note that you may specify multiple
17-
files via any of these methods. When using the command line, wildcards should
18-
work (e.g. python analyze.py c:\\data\\AEH\\AEH350\\ABR-\*)
19-
20-
Program Options
21-
---------------
22-
Options are specified via the command line
23-
24-
Usage: analyze.py [options] [filenames]
25-
26-
Options:
27-
-h, --help show this help message and exit
28-
--nofilter Do not filter waveform
29-
--lowpass=LOWPASS Lowpass cutoff (Hz), default 10,000 Hz
30-
--highpass=HIGHPASS Highpass cutoff (Hz), default 200 Hz
31-
--order=ORDER Filter order, default 1st order
32-
-d DIRECTORY, --directory=DIRECTORY
33-
Default directory for files
34-
-i, --invert Invert waveform polarity when waveforms are loaded
35-
--demo Load demo data
36-
37-
If you regularly use the program with a different set of default values, I
38-
recommend you create a shortcut or alias that contains these defaults. Under
39-
Windows, you can create a shortcut by right-clicking on the desktop (or an
40-
explorer window), selecting "New -> Shortcut" from the pop-up menu. You will
41-
get a dialog box asking to type the location of the item. Enter the following
42-
string:
43-
44-
python C:\\programs\\ABR\\analyze.py --invert --directory c:\\data
45-
46-
Where C:\\programs\\ABR\\analyze.py and c:\\data would be replaced with the
47-
appropriate path to the program and your data directory and the options list
48-
would be replaced with your preferred options.
49-
5012
Analysis
5113
--------
5214
On load each waveform is bandpass filtered using a butterworth filter (filter
@@ -90,13 +52,13 @@ The following keybindings are used when analyzing a waveform series:
9052
Right/Left arrows
9153
Move a toggled peak left or right along the waveform. Movement of the
9254
peak will "snap" to estimated peaks in the waveform. To adjust the peak
93-
in fine increments, hold down the shift key simultaneously.
55+
in fine increments, hold down the alt key simultaneously.
9456
Number keys 1-5
9557
Select the corresponding peak on the current waveform. To select N1-5,
96-
hold down shift while pressing the corresponding number.
58+
hold down alt while pressing the corresponding number.
9759
I
98-
Estimates N1-5 for all waveforms. If N1-5 is already estimated,
99-
recomputes the estimate.
60+
Estimates P1-5 for all waveforms on the first press. N1-5 for all
61+
waveforms on the second press. After that, nothing happens.
10062
U
10163
Updates guess for corresponding P or N of successive waveforms based on
10264
position of currently toggled P or N.
@@ -108,26 +70,14 @@ The following keybindings are used when analyzing a waveform series:
10870
Saves amplitude and latency of peaks.
10971
T
11072
Set threshold to current waveform.
73+
Alt+Up
74+
Indicate that all waveforms are below threshold.
75+
Alt+Down
76+
Indicate that all waveforms are above threshold.
11177

11278
Some keys will repeat if you hold down the key, which may be useful when
11379
navigating through the waveforms or adjusting the location of a peak.
11480

115-
Code Dependencies
116-
-----------------
117-
118-
wxPython_, numpy_, scipy_, matplotlib_
119-
120-
.. _wxPython: http://www.wxpython.org/
121-
.. _numpy: http://numpy.scipy.org/
122-
.. _scipy: http://www.scipy.org/
123-
.. _matplotlib: http://matplotlib.sourceforge.net/
124-
125-
The simplest way to satisfy these dependencies is to install `Python(x,y)`_ or the
126-
`Enthought Python Distribution`_.
127-
128-
.. _`Python(x,y)`: http://www.pythonxy.com
129-
.. _`Enthought Python Distribution`: http://www.enthought.com/products/epd.php
130-
13181
The Algorithm
13282
-------------
13383
See the documentation on find_np in peakdetect.py for an overview of how the

0 commit comments

Comments
 (0)