summaryrefslogtreecommitdiff
path: root/Readme.rst
diff options
context:
space:
mode:
authorMario Mulansky <mario.mulansky@gmx.net>2014-11-04 09:38:42 +0100
committerMario Mulansky <mario.mulansky@gmx.net>2014-11-04 09:38:42 +0100
commit110d9c0e596c7a87fdc1c890e48732acd98375d7 (patch)
tree7370d465ff9fc83185a202a33033a50f0d16ce2d /Readme.rst
parent8b5b287a79f3b42ddfefdf30ecf435f77306cfb8 (diff)
change "sort" parameter to "is_sorted"
Diffstat (limited to 'Readme.rst')
-rw-r--r--Readme.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Readme.rst b/Readme.rst
index b9f29e3..662cc1f 100644
--- a/Readme.rst
+++ b/Readme.rst
@@ -78,7 +78,7 @@ To quickly obtain spike trains from such files, PySpike provides the function :c
This function expects the name of the data file as first parameter.
Additionally, the time interval of the spike train measurement can be provided as a pair of start- and end-time values.
If the time interval is provided (:code:`time_interval is not None`), auxiliary spikes at the start- and end-time of the interval are added to the spike trains.
-Furthermore, the spike trains are ordered via :code:`np.sort` (disable this feature by providing :code:`sort=False` as a parameter to the load function).
+Furthermore, the spike trains are sorted via :code:`np.sort` (disable this feature by providing :code:`is_sorted=True` as a parameter to the load function).
As result, :code:`load_spike_trains_from_txt` returns a *list of arrays* containing the spike trains in the text file.
If you load spike trains yourself, i.e. from data files with different structure, you can use the helper function :code:`add_auxiliary_spikes` to add the auxiliary spikes at the beginning and end of the observation interval.
@@ -99,7 +99,7 @@ Computing bivariate distances profiles
Spike trains are expected to be *sorted*!
For performance reasons, the PySpike distance functions do not check if the spike trains provided are indeed sorted.
- Make sure that all your spike trains are sorted.
+ Make sure that all your spike trains are sorted, which is ensured if you use the `load_spike_trains_from_txt` function with the parameter `is_sorted=False`.
If in doubt, use :code:`spike_train = np.sort(spike_train)` to obtain a correctly sorted spike train.
Furthermore, the spike trains should have auxiliary spikes at the beginning and end of the observation interval.