Add support for bandstop filter type (#1464)

* Add support for bandstop filter type

Extended FirFilterParameters to include 'bandstop' as a valid filter type. Updated validation and filter coefficient logic to handle bandstop filters alongside existing types.

* Update changelog for bandstop filter support

Added a changelog entry for bandstop filter type support and updated the code example to use FirFilterParameters().alter().

Author: edeno

CHANGELOG.md

@@ -8,8 +8,10 @@ Running draft to be removed immediately prior to release. When altering tables,
 import all foreign key references.
 
 ```python
+from spyglass.common.common_filter import FirFilterParameters
 from spyglass.decoding.v1.core import DecodingParameters
 
+FirFilterParameters().alter()
 DecodingParameters().alter()
 ```
 
@@ -19,6 +21,7 @@ DecodingParameters().alter()
 - Add note on fetching changes to setup notebook #1371
 - Revise table field docstring heading and `mermaid` diagram generation #1402
 - Add pages for custom analysis tables and class inheritance structure #1435
+- Add support for bandstop filter type #1464
 
 ### Infrastructure
 

src/spyglass/common/common_filter.py

@@ -58,7 +58,7 @@ class FirFilterParameters(SpyglassMixin, dj.Manual):
     filter_name: varchar(80)           # descriptive name of this filter
     filter_sampling_rate: int          # sampling rate for this filter
     ---
-    filter_type: enum("lowpass", "highpass", "bandpass")
+    filter_type: enum("lowpass", "highpass", "bandpass", "bandstop") # type of filter
     filter_low_stop = 0: float     # lowest freq for stop band for low filt
     filter_low_pass = 0: float     # lowest freq for pass band of low filt
     filter_high_pass = 0: float    # highest freq for pass band for high filt
@@ -103,7 +103,12 @@ def add_filter(
         Exception:
             Raises an exception if an unexpected filter type is encountered.
         """
-        VALID_FILTERS = {"lowpass": 2, "highpass": 2, "bandpass": 4}
+        VALID_FILTERS = {
+            "lowpass": 2,  # low_stop, low_pass
+            "highpass": 2,  # high_stop, high_pass
+            "bandpass": 4,  # low_stop, low_pass, high_pass, high_stop
+            "bandstop": 4,  # low_stop, low_pass, high_pass, high_stop
+        }
         FILTER_ERR = "Error in Filter.add_filter: "
         FILTER_N_ERR = FILTER_ERR + "filter {} requires {} band_frequencies."
 
@@ -112,6 +117,7 @@ def add_filter(
         #   low pass : [high_pass high_stop]
         #   high pass: [low stop low pass]
         #   band pass: [low_stop low_pass high_pass high_stop].
+        #   band stop: [low_stop low_pass high_pass high_stop].
         if filter_type not in VALID_FILTERS:
             logger.error(
                 FILTER_ERR
@@ -164,14 +170,24 @@ def add_filter(
                 "filter_low_stop": band_edges[0],
                 "filter_low_pass": band_edges[1],
             }
-        else:
+        elif filter_type == "bandpass":
             desired = [0, 1, 1, 0]
             pass_stop_dict = {
                 "filter_low_stop": band_edges[0],
                 "filter_low_pass": band_edges[1],
                 "filter_high_pass": band_edges[2],
                 "filter_high_stop": band_edges[3],
             }
+        elif filter_type == "bandstop":
+            desired = [1, 0, 0, 1]
+            pass_stop_dict = {
+                "filter_low_stop": band_edges[0],
+                "filter_low_pass": band_edges[1],
+                "filter_high_pass": band_edges[2],
+                "filter_high_stop": band_edges[3],
+            }
+        else:
+            raise ValueError(f"Unhandled filter_type: {filter_type}")
 
         # create 1d array for coefficients
         filterdict.update(