Docs / Cards / Band Pass
Band Pass
Keeps frequencies between two bounds using a windowed FIR filter.
| Identifier | signalstudio.band_pass |
|---|---|
| Category | preprocessing.temporal |
| Since | 0.1.0 |
Ports
| Port | Direction | Type | Notes |
|---|---|---|---|
in | input | Raw|Epochs | Continuous recording or epoched trials. |
out | output | Raw|Epochs | Same type as the input, filtered. |
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
l_freq | float | 1.0 Hz | Lower bound. Below this, content is attenuated. |
h_freq | float | 40.0 Hz | Upper bound. |
transition | float | 0.0 Hz | Transition width. 0 resolves to an automatic value shown in the gears view. |
window | enum | hamming | Window applied to the filter kernel. one of: hamming, hann, blackman |
phase | enum | zero | Zero phase filters forward and backward, doubling the effective order. one of: zero, minimum |
Validation
Checked against an independent implementation on a real recording.
| Reference | MNE FIR filter |
|---|---|
| Dataset | P01 |
| Agreement | r = 0.99 |
Confirm these figures against a current harness run before citing them. How validation works
Manifest
card.json
{
"id": "signalstudio.band_pass",
"name": "Band Pass",
"category": "preprocessing.temporal",
"inputs": [
{
"id": "in",
"type": "Raw|Epochs",
"doc": "Continuous recording or epoched trials."
}
],
"outputs": [
{
"id": "out",
"type": "Raw|Epochs",
"doc": "Same type as the input, filtered."
}
],
"params": {
"l_freq": {
"type": "float",
"default": 1.0,
"unit": "Hz",
"doc": "Lower bound. Below this, content is attenuated."
},
"h_freq": {
"type": "float",
"default": 40.0,
"unit": "Hz",
"doc": "Upper bound."
},
"transition": {
"type": "float",
"default": 0.0,
"unit": "Hz",
"doc": "Transition width. 0 resolves to an automatic value shown in the gears view."
},
"window": {
"type": "enum",
"default": "hamming",
"values": [
"hamming",
"hann",
"blackman"
],
"doc": "Window applied to the filter kernel."
},
"phase": {
"type": "enum",
"default": "zero",
"values": [
"zero",
"minimum"
],
"doc": "Zero phase filters forward and backward, doubling the effective order."
}
}
}