You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/source/io.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,7 +114,7 @@ Read a time slice of Segment
114
114
115
115
Some objects support the ``time_slice`` argument in ``read_segment()``.
116
116
This is useful to read only a subset of a dataset clipped in time.
117
-
By default ``time_slice=None`` meaning load everything.
117
+
By default ``time_slice=None`` will load everything.
118
118
119
119
This reads everything::
120
120
@@ -130,7 +130,7 @@ This reads only the first 5 seconds::
130
130
Lazy option and proxy objects
131
131
=============================
132
132
133
-
In some cases you may not want to load everything in memory because it could be too big.
133
+
In some cases you may not want to load everything in memory (RAM) because it could be too big.
134
134
For this scenario, some IOs implement ``lazy=True/False``.
135
135
Since neo 0.7, a new lazy system has been added for some IO modules (all IO classes that inherit from rawio).
136
136
To know if a class supports lazy mode use ``ClassIO.support_lazy``.
@@ -144,12 +144,12 @@ These proxy objects contain metadata (name, sampling_rate, id, ...) so they can
144
144
but they do not contain any array-like data.
145
145
All proxy objects contain a ``load()`` method to postpone the real load of array like data.
146
146
147
-
Further more the ``load()`` method has a ``time_slice`` argument to load only a slice
147
+
Furthermore the ``load()`` method has a ``time_slice`` argument to load only a slice
148
148
from the file. In this way the consumption of memory can be finely controlled.
149
149
150
150
151
151
Here are two examples that read a dataset, extract sections of the signal based on recorded events,
152
-
and averages the sections.
152
+
and average the sections.
153
153
154
154
The first example is without lazy mode, so it consumes more memory::
155
155
@@ -178,7 +178,7 @@ The second example uses lazy mode, so it consumes less memory::
178
178
apply_my_fancy_average(all_sig_chunks)
179
179
180
180
In addition to ``time_slice``, AnalogSignalProxy supports the ``channel_indexes`` argument.
181
-
This allows loading only a subset of channels. This is useful where the channel count is very high.
181
+
This allows loading only a subset of channels. This is useful when the channel count is very high.
182
182
183
183
.. TODO: add something about magnitude mode when implemented for all objects.
184
184
@@ -295,7 +295,7 @@ For more complex logging, please see the documentation for the logging_ module.
295
295
296
296
.. note:: If you wish to implement more advanced logging as describe in the documentation for the logging_ module or elsewhere on the internet, please do so before calling any :mod:`neo` functions or initializing any :mod:`neo` classes.
297
297
This is because the default handler is created when :mod:`neo` is imported, but it is not attached to the :mod:`neo` logger until a class that uses logging is initialized or a function that uses logging is called.
298
-
Further, the handler is only attached if there are no handlers already attached to the root logger or the :mod:`neo` logger, so adding your own logger will override the default one.
298
+
Furthermore, the handler is only attached if there are no handlers already attached to the root logger or the :mod:`neo` logger, so adding your own logger will override the default one.
299
299
Additional functions and/or classes may get logging during bugfix releases, so code relying on particular modules not having logging may break at any time without warning.
0 commit comments