myokit 1.36.1__py3-none-any.whl → 1.37.1__py3-none-any.whl

myokit/formats/heka/_patchmaster.py

@@ -625,7 +625,7 @@ class Series(TreeNode, myokit.formats.SweepSource):
 
         1. In the individual :class:`Trace` objects. This is somewhat
            counter-intuitive as some of these properties (e.g.
-           :meth:Trace.pipette_resistance()`) were set before a series was
+           :meth:Trace.r_pipette()`) were set before a series was
            acquired and do no change between channels or sweeps.
         2. In the series' :class:`AmplifierState`, which can be accessed via
            the :meth:`amplifier_state()` method.
@@ -679,6 +679,13 @@ class Series(TreeNode, myokit.formats.SweepSource):
                 'Unexpected amplifier state offset: expecting 472 (information'
                 ' stored with Series) or 0 (information stored in .amp file).')
 
+        # Read user parameters
+        # handle.seek(i + 344)    # SeSeUserParams1 = 344; (* 4 x LONGREAL *)
+        # p = reader.read('dddd')
+        # handle.seek(i + 1120)    # SeSeUserParams2 = 1120; (* 4x LONGREAL *)
+        # p += reader.read('dddd')
+        # All zero!
+
     def _read_finalize(self):
         # See TreeNode._read_finalize
 
@@ -928,6 +935,7 @@ class Series(TreeNode, myokit.formats.SweepSource):
                 include_da = False
 
         # Populate log
+        log.set_time_key('time')
         if join_sweeps:
             # Join sweeps
             offsets = (self._sweep_starts_r if use_real_start_times
@@ -964,31 +972,61 @@ class Series(TreeNode, myokit.formats.SweepSource):
                     log.cmeta[name]['unit'] = self._da_units[0]
 
         # Add meta data
-        log.set_time_key('time')
+        log.meta['time'] = self._time.strftime(myokit.DATE_FORMAT)
         a = self.amplifier_state()
+        t = self[0][0] if len(self) and len(self[0]) else None
         log.meta['current_gain_mV_per_pA'] = a.current_gain()
+        log.meta['filter1'] = a.filter1_str()
+        log.meta['filter2'] = a.filter2_str()
+        log.meta['stimulus_filter'] = a.stimulus_filter_str()
         log.meta['ljp_correction_mV'] = a.ljp()
-        log.meta['c_slow_compensation_pF'] = a.c_slow()
+        log.meta['voltage_offset_mV'] = a.v_off()
+        log.meta['holding_potential_mV'] = a.v_hold()
+        if t is not None:
+            log.meta['r_pipette_MOhm'] = t.r_pipette()
+            log.meta['r_seal_MOhm'] = t.r_seal()
         if a.c_fast_enabled():
             log.meta['c_fast_compensation_enabled'] = 'true'
             log.meta['c_fast_pF'] = a.c_fast()
-            log.meta['c_fast_tau_micro_s'] = a.c_fast_tau()
+            log.meta['c_fast_tau_us'] = a.c_fast_tau()
         else:
             log.meta['c_fast_compensation_enabled'] = 'false'
+        log.meta['c_slow_pF'] = a.c_slow()
+        if a.c_slow_enabled():
+            log.meta['c_slow_compensation_enabled'] = 'true'
+            log.meta['c_slow_range'] = a.c_slow_range()
+            css = a.c_slow_auto_settings()
+            log.meta['c_slow_auto_amplitude_mV'] = css[0]
+            log.meta['c_slow_auto_cycles'] = css[1]
+            log.meta['c_slow_auto_timeout'] = css[2]
+        else:
+            log.meta['c_slow_compensation_enabled'] = 'false'
         log.meta['r_series_MOhm'] = a.r_series()
         if a.r_series_enabled():
             log.meta['r_series_compensation_enabled'] = 'true'
             log.meta['r_series_compensation_percent'] = round(
                 a.r_series_fraction() * 100, 1)
+            log.meta['r_series_compensation_tau_us'] = a.r_series_tau()
         else:
             log.meta['r_series_compensation_enabled'] = 'false'
-        if len(self) and len(self[0]):
-            t = self[0][0]
-            log.meta['r_pipette_MOhm'] = t.r_pipette()
-            log.meta['r_seal_MOhm'] = t.r_series()
-            log.meta['r_series_post_compensation_MOhm'] = \
-                t.r_series_remaining()
-            log.meta['c_slow_pF'] = t.c_slow()
+
+        # Add protocol to meta data
+        stimulus = self.stimulus()
+        stimulus_channel = stimulus.supported_channel()
+        if stimulus_channel is not None:
+            log.meta['amplifier_mode'] = str(stimulus_channel.amplifier_mode())
+            log.meta['protocol'] = stimulus.protocol().code()
+
+        # Add completion status
+        if stimulus_channel is None:
+            c = 'Unknown'
+        elif self.is_complete():
+            c = 'All sweeps ran and completed'
+        elif self._intended_sweep_count == len(self):
+            c = 'Final sweep incomplete'
+        else:
+            c = f'Ran {len(self)} out of {self._intended_sweep_count} sweeps'
+        log.meta['completed'] = c
 
         return log
 
@@ -1003,7 +1041,7 @@ class Series(TreeNode, myokit.formats.SweepSource):
         out.append(f'     version {self._file.version()}')
         out.append(f'Recorded on {self._time}')
         out.append(f'{len(self)} sweeps,'
-                   f' {len(self._channel_names)} channels.')
+                   f' {len(self._channel_names)} channels')
 
         # Completion status
         c = self._stimulus.supported_channel()
@@ -1018,62 +1056,79 @@ class Series(TreeNode, myokit.formats.SweepSource):
                 out.append(f'Incomplete recording: {len(self)} out of'
                            f' {self._intended_sweep_count} ran.')
 
-        # Resistance, capacitance, etc.
+        # Info from amplifier state
         a = self.amplifier_state()
         out.append('Information from amplifier state:')
         out.append(f'  Current gain: {a.current_gain()} mV/pA')
+        out.append(f'  Filter 1: {a.filter1_str()}')
+        out.append(f'  Filter 2: {a.filter2_str()}')
+        out.append(f'  Stimulus filter: {a.stimulus_filter_str()}')
+        # Voltage info
+        out.append(f'  Holding potential: {a.v_hold()} mV')
         if a.ljp():
-            out.append('  LJP correction applied using'
-                       f' LJP={round(a.ljp(), 4)} mV.')
+            out.append(f'  LJP correction: {round(a.ljp(), 4)} mV')
+        else:
+            out.append('  LJP correction: no correction')
+        out.append(f'  Voltage offset: {a.v_off()} mV')
+        # C fast
         if a.c_fast_enabled():
             out.append(f'  C fast compensation: {a.c_fast()} pF,'
-                       f' {round(a.c_fast_tau(), 4)} us.')
+                       f' {round(a.c_fast_tau(), 4)} us')
         else:
-            out.append('  C fast compensation: not enabled.')
-        out.append(f'  C slow compensation: {a.c_slow()} pF.')
-        out.append(f'  R series: {a.r_series()} MOhm.')
+            out.append('  C fast compensation: not enabled')
+        # C slow
+        if a.c_slow_enabled():
+            out.append(f'  C slow compensation: {a.c_slow()} pF')
+            amp, cyc, tim = a.c_slow_auto_settings()
+            out.append(f'  C slow auto settings: amplitude {amp} mV,'
+                       f' cycles {cyc}, timeout {tim} s')
+        else:
+            out.append('  C slow compensation: not enabled')
+        # Rs comp
+        out.append(f'  R series: {a.r_series()} MOhm')
         if a.r_series_enabled():
             p = round(a.r_series_fraction() * 100, 1)
-            out.append(f'  R series compensation: {p} %.')
+            q = round(a.r_series_tau(), 1)
+            out.append(f'  R series compensation: {p} %, {q} us')
         else:
             out.append('  R series compensation: not enabled')
+
+        # Info from first trace
         if len(self) and len(self[0]):
             t = self[0][0]
             out.append('Information from first trace:')
 
-            out.append(f'  Pipette resistance: {t.r_pipette()} MOhm.')
-            out.append(f'  Seal resistance: {t.r_seal()} MOhm.')
-            out.append(f'  Series resistance: {t.r_series()} MOhm.')
-            out.append(f'    after compensation: {t.r_series_remaining()}'
-                       f' MOhm.')
-            out.append(f'  C slow: {t.c_slow()} pF.')
+            out.append(f'  Pipette resistance: {t.r_pipette()} MOhm')
+            out.append(f'  Seal resistance: {t.r_seal()} MOhm')
+            out.append(f'  Series resistance: {t.r_series()} MOhm')
+            out.append(f'  C slow: {t.c_slow()} pF')
 
         # Sweeps and channels
         if verbose:
             out.append('-' * 60)
             for i, sweep in enumerate(self):
                 out.append(f'Sweep {i}, label: "{sweep.label()}", recorded on'
-                           f' {sweep.time()}.')
+                           f' {sweep.time()}')
                 if i == 0:
                     for j, trace in enumerate(self[0]):
                         out.append(f'  Trace {j}, label: "{trace.label()}",'
                                    f' in {trace.time_unit()} and'
-                                   f' {trace.value_unit()}.')
+                                   f' {trace.value_unit()}')
 
         # Stimulus
         if verbose:
             stim = self._stimulus
             out.append('-' * 60)
-            out.append(f'Stimulus "{stim.label()}".')
-            out.append(f'  {stim.sweep_count()} sweeps.')
-            out.append(f'  Delay between sweeps: {stim.sweep_interval()} s.')
-            out.append(f'  Sampling interval: {stim.sampling_interval()} s.')
+            out.append(f'Stimulus "{stim.label()}"')
+            out.append(f'  {stim.sweep_count()} sweeps')
+            out.append(f'  Delay between sweeps: {stim.sweep_interval()} s')
+            out.append(f'  Sampling interval: {stim.sampling_interval()} s')
             for i, ch in enumerate(stim):
                 out.append(f'  Channel {i}, in {ch.unit()}, amplifier in'
-                           f' {ch.amplifier_mode()} mode.')
-                out.append(f'  Stimulus reconstruction: {ch.support_str()}.')
+                           f' {ch.amplifier_mode()} mode')
+                out.append(f'  Stimulus reconstruction: {ch.support_str()}')
                 z = ch.zero_segment() or '0 (disabled)'
-                out.append(f'  Zero segment: {z}.')
+                out.append(f'  Zero segment: {z}')
                 for j, seg in enumerate(ch):
                     out.append(f'   Segment {j}, {seg.storage()}')
                     out.append(f'    {seg.segment_class()}, {seg}')
@@ -1274,7 +1329,6 @@ class Trace(TreeNode):
         # Meta data
         self._r_pipette = None
         self._r_seal = None
-        self._r_series_comp = None
         self._g_series = None
         self._c_slow = None
 
@@ -1329,8 +1383,8 @@ class Trace(TreeNode):
         self._c_slow = reader.read1('d')
         handle.seek(i + 184)  # TrGSeries            = 184; (* LONGREAL *)
         self._g_series = reader.read1('d')
-        handle.seek(i + 192)  # TrRsValue            = 192; (* LONGREAL *)
-        self._r_series_comp = reader.read1('d')
+        #handle.seek(i + 192)  # TrRsValue            = 192; (* LONGREAL *)
+        #self._r_series_comp = reader.read1('d')
 
         # Convert unit
         self._data_unit = myokit.parse_unit(self._data_unit)
@@ -1359,17 +1413,27 @@ class Trace(TreeNode):
 
     def r_seal(self):
         """
-        Returns the "seal resistance" (MOhm) determined in the waiting time
-        before the trace was acquired.
+        Returns the "seal resistance" (MOhm) that was determined the last time
+        that the "amplifier window" was active (so at some indeterminate time
+        before the Trace was aquired).
+
+        The values returned by :meth:`r_seal` and :meth:`r_pipette` are the
+        same measurement ("R-memb") performed at a different time. The value
+        ``r_seal`` is updated whenever the "amplifier window" is active. Using
+        a button or a programmed command, the same value can be stored as
+        ``r_pipette``, which should be done before breaking the seal.
 
-        This is equal to the value "R-memb" on the display. If a test pulse is
-        being used, it is calculated as dV/dI where dV and dI are the
-        differences in (command) voltage and current before and during the
-        pulse. If no test pulse is used it is simply the ratio between the V
-        and I measurements.
+        "R-memb" is determined either using a test pulse or from the current
+        V and I values. If a test pulse is used (the default), this is
+        specified as a ``dV`` from the holding potential, and
+        ``R-memb = dV / dI`` where ``dV`` is the difference in command
+        potential and ``dI`` is the measured difference in current (I during
+        the step minus I at holding potential).
 
-        This is the same measurement as :meth:`r_pipette`, but logged
-        automatically before each trace.
+        Users should be careful when interpreting this value, as it depends on
+        (1) the last time that the amplifier window was active, (2) the test
+        pulse settings, (3) the holding potential, (4) any currents active at
+        the holding potential or during the step.
         """
         return self._r_seal * 1e-6
 
@@ -1380,24 +1444,14 @@ class Trace(TreeNode):
         """
         return 1e-6 / self._g_series
 
-    def r_series_remaining(self):
-        """
-        Returns the series resistance (MOhm) remaining after compensation.
-        """
-        # "Absolute fraction of the compensated R-series value. The value
-        # depends on the % of R-series compensation."
-        return (1 / self._g_series - self._r_series_comp) * 1e-6
-
     def r_pipette(self):
         """
-        Returns the pipette resistance (MOhm) determined from the test pulse
-        before breaking the seal.
+        Returns the pipette resistance (MOhm) stored with this Trace, but
+        calculated at an earlier point.
 
-        This is equal to the value "R-memb" on the display, but logged when a
-        "R-memb to R-pip" button was pressed (or called programmatically). It
-        uses the same measurement as  :meth:`r_seal`, but logged at a different
-        time. The intended use is to store the resistance of the pipette tip
-        before touching a cell.
+        Like the "seal resistance", the "pipette resistance" is a stored
+        measurement of what patchmaster calls "R-memb". For details, see
+        :meth:`r_seal`.
         """
         return self._r_pipette * 1e-6
 
@@ -1572,13 +1626,6 @@ class AmplifierState:
     """
     Describes the state of an amplifier used by PatchMaster.
     """
-    _filter1_options = [
-        'Bessel 100 kHz',
-        'Bessel 30 kHz',
-        'Bessel 10 kHz',
-        'HQ 30 kHz',
-    ]
-
     def __init__(self, handle, reader):
 
         # Read properties
@@ -1588,6 +1635,14 @@ class AmplifierState:
         handle.seek(i + 8)      # sCurrentGain = 8;  (* LONGREAL *)
         self._current_gain = reader.read1('d')
 
+        # Holding potential and offsets
+        handle.seek(i + 112)  # sVHold = 112; (* LONGREAL *)
+        self._holding = reader.read1('d')
+        handle.seek(i + 128)  # sVpOffset = 128; (* LONGREAL *)
+        self._voff = reader.read1('d')
+        handle.seek(i + 136)  # sVLiquidJunction = 136; (* LONGREAL *)
+        self._ljp = reader.read1('d')
+
         # Series resistance and compensation
         handle.seek(i + 40)     # sRsFraction = 40; (* LONGREAL *)
         self._rs_fraction = reader.read1('d')
@@ -1605,12 +1660,15 @@ class AmplifierState:
         self._cf_amp2 = reader.read1('d')
         handle.seek(i + 72)    # sCFastTau = 72; (* LONGREAL *)
         self._cf_tau = reader.read1('d')
-        handle.seek(i + 285)   # sCCCFastOn = 285; (* BYTE *)
-        self._cf_enabled = bool(reader.read1('b'))
+        #handle.seek(i + 285)   # sCCCFastOn = 285; (* BYTE *)
+        #self._cf_enabled = bool(reader.read1('b'))
 
         # Slow capacitance correction
         handle.seek(i + 80)    # sCSlow = 80; (* LONGREAL *)
         self._cs = reader.read1('d')
+        handle.seek(i + 241)   # sCSlowRange = 241; (* BYTE *)
+        self._cs_range = CSlowRange(reader.read1('b'))
+
         # Auto CSlow settings. See 4.9 "EPC 10 USB Menu" in the manual.
         handle.seek(i + 152)    # sCSlowStimVolts = 152; (* LONGREAL *)
         self._cs_auto_stim = reader.read1('d')
@@ -1619,71 +1677,78 @@ class AmplifierState:
         handle.seek(i + 210)    # sCSlowCycles = 210; (* INT16 *)
         self._cs_auto_cycles = reader.read1('h')
 
-        # Voltage offsets
-        handle.seek(i + 128)  # sVpOffset = 128; (* LONGREAL *)
-        self._voff = reader.read1('d')
-        handle.seek(i + 136)  # sVLiquidJunction = 136; (* LONGREAL *)
-        self._ljp = reader.read1('d')
-
         # Filter 1
+        # Set with a byte that controls type and frequency
         handle.seek(i + 281)  # sFilter1 = 281; (* BYTE *)
-        self._filter1 = reader.read1('b')
+        self._filter1 = Filter1Setting(reader.read1('b'))
+
+        # Filter 2
+        # Set with a type and a separate frequency. The user setting for Filter
+        # 2 is the combined bandwidth of Filter 1 and Filter 2.
+        handle.seek(i + 239)  # sF2Response = 239; (* BYTE *)
+        self._filter2_type = Filter2Type(reader.read1('b'))
+        handle.seek(i + 24)  # sF2Frequency = 24; (* LONGREAL *)
+        self._filter2_freq_solo = reader.read1('d')
+        handle.seek(i + 16)  # sF2Bandwidth = 16; (* LONGREAL *)
+        self._filter2_freq_both = reader.read1('d')
+
+        # Suspect this indicates external filter 2
+        #handle.seek(i + 287)  # sF2Source = 287; (* BYTE *)
+        #self._temp['sF2Source'] = reader.read1('b')
+        # Don't know what Mode does.
+        #handle.seek(i + 231)  # sF2Mode = 231; (* BYTE *)
+        #self._temp['sF2Mode'] = reader.read1('b')
 
-        #TODO: Add these are proper properties with a docstring'd method that
-        # returns them and says what the units are etc. or stop reading them.
         # self._temp = {}
-        # handle.seek(i + 264)  # sImon1Bandwidth = 264; (* LONGREAL *)
-        # self._temp['sImon1Bandwidth'] = reader.read1('d')
-
-        # handle.seek(i + 16)  # sF2Bandwidth = 16; (* LONGREAL *)
-        # self._temp['sF2Bandwidth'] = reader.read1('d')
-        # handle.seek(i + 24)  # sF2Frequency = 24; (* LONGREAL *)
-        # self._temp['sF2Frequency'] = reader.read1('d')
-        # handle.seek(i + 230)  # sHasF2Bypass = 230; (* BYTE *)
-        # self._temp['sHasF2Bypass'] = reader.read1('b')
-        # handle.seek(i + 231)  # sF2Mode = 231; (* BYTE *)
-        # self._temp['sF2Mode'] = reader.read1('b')
-        # handle.seek(i + 239)  # sF2Response = 239; (* BYTE *)
-        # self._temp['sF2Response'] = reader.read1('b')
-        # handle.seek(i + 287)  # sF2Source = 287; (* BYTE *)
-        # self._temp['sF2Source'] = reader.read1('b')
-
         # handle.seek(i + 296)  # sStimFilterHz = 296; (* LONGREAL *)
-        # self._temp['sStimFilterHz'] = reader.read1('d')
+        # print('STIM', reader.read1('d'))
         # handle.seek(i + 320)  # sInputFilterTau = 320; (* LONGREAL *)
+        # print('InputFilterTau', reader.read1('d'))
         # self._temp['sInputFilterTau'] = reader.read1('d')
         # handle.seek(i + 328)  # sOutputFilterTau = 328; (* LONGREAL *)
+        # print('OutputFilterTau', reader.read1('d'))
         # self._temp['sOutputFilterTau'] = reader.read1('d')
-
         # handle.seek(i + 384)  # sVmonFiltBandwidth = 384; (* LONGREAL *)
         # self._temp['sVmonFiltBandwidth'] = reader.read1('d')
         # handle.seek(i + 392)  # sVmonFiltFrequency = 392; (* LONGREAL *)
         # self._temp['sVmonFiltFrequency'] = reader.read1('d')
+        # handle.seek(i + 264)  # sImon1Bandwidth = 264; (* LONGREAL *)
+        # self._temp['sImon1Bandwidth'] = reader.read1('d')
 
-        # handle.seek(i + 112)  # sVHold = 112; (* LONGREAL *)
-        # self._temp['sVHold'] = reader.read1('d')
-        # handle.seek(i + 120)  # sLastVHold = 120; (* LONGREAL *)
-        # self._temp['sLastVHold'] = reader.read1('d')
+        # Stimulus filter
+        handle.seek(i + 282)  # sStimFilterOn = 282; (* BYTE *)
+        self._stimulus_filter = StimulusFilterSetting(reader.read1('b'))
 
     def c_fast(self):
         """
-        Return the capacitance (pF) used in fast capacitance correction
-        (CFast2).
+        Return the capacitance (pF) used in fast capacitance correction.
+
+        HEKA amplifiers use a two-component fast capacitance cancellation, with
+        an instantaneous part (component 1) and a delayed part (component 2).
+
+        The "total" capacitance, e.g. the sum of components 1 and 2 is
+        returned.
         """
-        # Not sure why there are two. They are almost identical. Older EPC9
-        # manual has a Fast1 and Fast2 as well, but only for GET, for SET there
-        # is only 2. So... going with that for now
-        return self._cf_amp2 * 1e12
+        # The total fast capacitance correction is a sum of two capacitances.
+        # See the EPC-10 manual for details.
+        return (self._cf_amp1 + self._cf_amp2) * 1e12
 
     def c_fast_tau(self):
         """
-        Returns the time constant (us) used in fast capacitance correction.
+        Returns the time constant (in microseconds) used in fast capacitance
+        correction.
+
+        This is the time constant for the non-instantaneous component of the
+        cancellation, see :meth:`c_fast`.
         """
         return self._cf_tau * 1e6
 
     def c_fast_enabled(self):
-        """ Returns ``True`` if fast capacitance compensation was enabled. """
-        return self._cf_enabled
+        """
+        Returns ``True`` if the fast capacitance compensation is set to a
+        non-zero capacitance.
+        """
+        return (self._cf_amp1 + self._cf_amp2) > 0
 
     def c_slow(self):
         """
@@ -1701,6 +1766,18 @@ class AmplifierState:
         return (self._cs_auto_stim * 1e3, self._cs_auto_cycles,
                 self._cs_auto_timeout)
 
+    def c_slow_enabled(self):
+        """
+        Returns ``True`` if the C-slow range is not set to 'Off'.
+        """
+        return self._cs_range is not CSlowRange.OFF
+
+    def c_slow_range(self):
+        """
+        Returns the :class:`CSlowRange` used for slow capacitance correction.
+        """
+        return self._cs_range
+
     def current_gain(self):
         """
         The gain setting for current measurements, in mV/pA.
@@ -1709,9 +1786,50 @@ class AmplifierState:
 
     def filter1(self):
         """
-        Returns a string describing the used (always-on) analog Filter 1.
+        Returns a :class:`Filter1Setting` describing filter 1.
+
+        For more information on Filter 1 and 2, see :class:`Filter1Setting`.
+        """
+        return self._filter1
+
+    def filter1_str(self):
         """
-        return self._filter1_options[self._filter1]
+        Returns a string representing the Filter 1 settings.
+
+        For more information on Filter 1 and 2, see :class:`Filter1Setting`.
+        """
+        return str(self._filter1)
+
+    def filter2(self):
+        """
+        Returns a tuple ``(type, f_both, f_solo)`` describing the Filter 2
+        settings, where ``type`` is a :class:`Filter2Type`, where ``f_both`` is
+        the frequency in Hz of both filters combined, and when ``f_solo`` is
+        the frequency of Filter 2 alone.
+
+        The frequency shown in PatchMaster is that of both filters combined.
+        If the "bypass" filter is selected, the frequency settings are unused.
+
+        For more information on Filter 1 and 2, see :class:`Filter1Setting`.
+        """
+        return (
+            self._filter2_type,
+            self._filter2_freq_both,
+            self._filter2_freq_solo,
+        )
+
+    def filter2_str(self):
+        """
+        Returns a string describing Filter 2.
+
+        For more information on Filter 1 and 2, see :class:`Filter1Setting`.
+        """
+        if self._filter2_type is Filter2Type.BYPASS:
+            return str(self._filter2_type)
+        fb = round(self._filter2_freq_both * 1e-3, 2)
+        fs = round(self._filter2_freq_solo * 1e-3, 2)
+        fb = int(fb) if fb == int(fb) else fb
+        return f'{self._filter2_type} {fb} kHz combined, {fs} kHz f2-only'
 
     def ljp(self):
         """
@@ -1757,12 +1875,122 @@ class AmplifierState:
         """
         return self._rs_tau * 1e6 if self._rs_enabled else 0
 
-    def v_off(self):
+    def stimulus_filter(self):
+        """
+        Returns a :class:`StimulusFilterSetting` descibing the stimulus filter
+        settings.
+
+        For more information, see :class:`StimulusFilterSetting`.
+        """
+        return self._stimulus_filter
+
+    def stimulus_filter_str(self):
         """
-        Returns the used voltage offset (in mV), also called V0.
+        Returns a string descibing the stimulus filter settings.
+
+        For more information, see :class:`StimulusFilterSetting`.
         """
+        return self._stimulus_filter
+
+    def v_off(self):
+        """ Returns the used voltage offset (in mV), also called V0. """
         return self._voff * 1e3
 
+    def v_hold(self):
+        """ Returns the holding potential (in mV). """
+        return self._holding * 1e3
+
+
+class Filter1Setting(enum.Enum):
+    """
+    Settings for filter 1, which is applied before filter 2.
+
+    Both filter 1 and filter 2 are hardware filters, implemented on the EPC 9
+    and 10. Filter 1 is used in voltage control, while filter 2 is used to
+    perform filtering before digitisation. Filter 1 is always on, but some
+    amplifiers allow filter 2 to be bypassed. The setting for filter 1
+    determines both the type of filter (Bessel etc.) and the bandwidth. The
+    user setting for filter 2 sets the combined bandwidth of both filters.
+
+    Measurements that passed only through filter 1 can be obtained from
+    Imon1, while Imon2 provides output passed through both filters.
+    """
+    BESSEL_100K = 0
+    BESSEL_30K = 1
+    BESSEL_10K = 2
+    HQ_30K = 3
+
+    def __str__(self):
+        if self is Filter1Setting.BESSEL_100K:
+            return 'Bessel 100 kHz'
+        elif self is Filter1Setting.BESSEL_30K:
+            return 'Bessel 30 kHz'
+        elif self is Filter1Setting.BESSEL_10K:
+            return 'Bessel 10 kHz'
+        else:
+            return 'HQ 30 kHz'
+
+
+class Filter2Type(enum.Enum):
+    """
+    Setting for filter 2, which is applied after filter 1.
+
+    Unlike Filter 1, this filter can be disabled, and the frequency is set
+    separately.
+
+    For more information on the filters, see :class:`Filter1Setting`.
+    """
+    BESSEL = 0
+    BUTTERWORTH = 1
+    BYPASS = 2
+    #V_BESSEL = 3   Maybe!
+    #V_Butterworth = 4  Maybe!
+
+    def __str__(self):
+        if self is Filter2Type.BESSEL:
+            return 'Bessel'
+        elif self is Filter2Type.BUTTERWORTH:
+            return 'Butterworth'
+        else:
+            return 'Bypass'
+
+
+class CSlowRange(enum.Enum):
+    """ Available options for slow capacitance cancelling range. """
+    OFF = 0
+    pF30 = 1
+    pF100 = 2
+    pF1000 = 3
+
+    def __str__(self):
+        if self is CSlowRange.OFF:
+            return 'Off'
+        elif self is CSlowRange.pF30:
+            return '30 pF'
+        elif self is CSlowRange.pF100:
+            return '100 pF'
+        else:
+            return '1000 pF'
+
+
+class StimulusFilterSetting(enum.Enum):
+    """
+    Setting for the stimulus filter.
+
+
+    The stimulus filter is a 2-pole Bessel filter applied over the stimulus
+    signal to reduce fast capacitative currents. It is applied to voltages, the
+    manual is less clear whether it is applied to currents too.
+    """
+    BW2 = 0
+    BW20 = 1
+
+    def __str__(self):
+        if self is StimulusFilterSetting.BW2:
+            return 'Bessel 2 us (off)'
+        else:
+            return 'Bessel 20 us (on)'
+
 
 #
 # From StimFile_v9.txt
@@ -1879,6 +2107,8 @@ class Stimulus(TreeNode):
         handle.seek(start + 144)  # stNumberSweeps = 144; (* INT32 *)
         self._sweep_count = reader.read1('i')
 
+        # Filterfactor: Determines desired filtering frequency as a function of
+        # sampling rate. Is overruled by autofilter when enabled.
         # handle.seek(start + 136)  # stFilterFactor = 136; (* LONGREAL *)
         # self._filter_factor = reader.read1('d')