@@ -64,17 +64,22 @@ Reader parameters
6464 - Description
6565 * - ``voltage_compress ``
6666 - ``False ``
67- - Split voltage into step boundaries (returns list of tuples instead of
68- flat array).
67+ - Split voltage into step boundaries (returns list of tuples
68+ instead of flat array). Set to ``True `` when the voltage
69+ protocol is strictly composed of DC steps, or ``False `` if
70+ the protocol contains AC elements (Triangle, Sine, Saw, etc.)
6971 * - ``downsample ``
7072 - ``1 ``
7173 - Integer downsampling factor. ``downsample=5 `` keeps every 5th sample.
74+ Note that downsampling is not reversible; only the downsampled data is retained.
75+ Effective sampling frequency (``Raw sampling frequency / downsample ``) is automatically calculated and returned in ``metadata["eff_sampling_freq"] ``
7276 * - ``n_remove ``
7377 - ``0 ``
7478 - Samples to discard from the start of each voltage step.
7579 * - ``prefilter ``
7680 - ``None ``
77- - A callable applied to the raw current before returning.
81+ - A callable applied to the raw current before downsampling is performed.
82+ Can be an instance of ``utils.Filter ``, ``utils.ClockFilter `` etc.
7883
7984.. code-block :: python
8085
@@ -143,7 +148,7 @@ into constant-voltage segments.
143148 :alt: Current trace with voltage protocol below
144149 :width: 100%
145150
146- Under the hood, ``utils.split_voltage_steps() `` finds voltage transitions:
151+ Under the hood, when voltage_compress=True, ``utils.split_voltage_steps() `` finds DC voltage transitions:
147152
148153.. code-block :: python
149154
@@ -160,6 +165,7 @@ Under the hood, ``utils.split_voltage_steps()`` finds voltage transitions:
160165 # [(0, 100000), (100000, 200000), (200000, 900000), (900000, 1000000)]
161166
162167
168+
163169 SessionFileManager
164170------------------
165171
0 commit comments