Add support for ElectricalSeries.filtering dataset

src/pynwb/ecephys.py

@@ -49,7 +49,8 @@ class ElectricalSeries(TimeSeries):
 
     __nwbfields__ = ({'name': 'electrodes', 'required_name': 'electrodes',
                       'doc': 'the electrodes that generated this electrical series', 'child': True},
-                     'channel_conversion')
+                     'channel_conversion',
+                     'filtering')
 
     @docval(*get_docval(TimeSeries.__init__, 'name'),  # required
             {'name': 'data', 'type': ('array_data', 'data', TimeSeries),  # required
@@ -65,13 +66,21 @@ class ElectricalSeries(TimeSeries):
              "to support the storage of electrical recordings as native values generated by data acquisition systems. "
              "If this dataset is not present, then there is no channel-specific conversion factor, i.e. it is 1 for all"
              " channels.", 'default': None},
+            {'name': 'filtering', 'type': str, 'doc':
+             "Filtering applied to all channels of the data. For example, if this ElectricalSeries represents "
+             "high-pass-filtered data (also known as AP Band), then this value could be 'High-pass 4-pole Bessel "
+             "filter at 500 Hz'. If this ElectricalSeries represents low-pass-filtered LFP data and the type of "
+             "filter is unknown, then this value could be 'Low-pass filter at 300 Hz'. If a non-standard filter "
+             "type is used, provide as much detail about the filter properties as possible.", 'default': None},
             *get_docval(TimeSeries.__init__, 'resolution', 'conversion', 'timestamps', 'starting_time', 'rate',
                         'comments', 'description', 'control', 'control_description'))
     def __init__(self, **kwargs):
-        name, electrodes, data, channel_conversion = popargs('name', 'electrodes', 'data', 'channel_conversion', kwargs)
+        name, electrodes, data, channel_conversion, filtering = popargs('name', 'electrodes', 'data',
+                                                                        'channel_conversion', 'filtering', kwargs)
         super(ElectricalSeries, self).__init__(name, data, 'volts', **kwargs)
         self.electrodes = electrodes
         self.channel_conversion = channel_conversion
+        self.filtering = filtering
 
 
 @register_class('SpikeEventSeries', CORE_NAMESPACE)

tests/integration/hdf5/test_ecephys.py

@@ -52,11 +52,16 @@ def setUpContainer(self):
                                     table=self.table)
         data = list(zip(range(10), range(10, 20)))
         timestamps = list(map(lambda x: x/10., range(10)))
-        es = ElectricalSeries(name='test_eS',
-                              data=data,
-                              electrodes=region,
-                              channel_conversion=[4., .4],
-                              timestamps=timestamps)
+        channel_conversion = [1., 2., 3., 4.]
+        filtering = 'Low-pass filter at 300 Hz'
+        es = ElectricalSeries(
+            name='test_eS',
+            data=data,
+            electrodes=region,
+            channel_conversion=channel_conversion,
+            filtering=filtering,
+            timestamps=timestamps
+        )
         return es
 
     def addContainer(self, nwbfile):

tests/unit/test_ecephys.py

@@ -29,12 +29,24 @@ class ElectricalSeriesConstructor(TestCase):
     def test_init(self):
         data = list(range(10))
         ts = [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]
+        channel_conversion = [2., 6.3]
+        filtering = 'Low-pass filter at 300 Hz'
         table = make_electrode_table()
         region = DynamicTableRegion('electrodes', [0, 2], 'the first and third electrodes', table)
-        eS = ElectricalSeries('test_eS', data, region, channel_conversion=[2., 6.3], timestamps=ts)
+        eS = ElectricalSeries(
+            name='test_eS',
+            data=data,
+            electrodes=region,
+            channel_conversion=channel_conversion,
+            filtering=filtering,
+            timestamps=ts
+        )
         self.assertEqual(eS.name, 'test_eS')
         self.assertEqual(eS.data, data)
+        self.assertEqual(eS.electrodes, region)
         self.assertEqual(eS.timestamps, ts)
+        self.assertEqual(eS.channel_conversion, [2., 6.3])
+        self.assertEqual(eS.filtering, filtering)
 
     def test_link(self):
         table = make_electrode_table()