Docs / Cards / Bipolar Reference
Bipolar Reference
Re-references each channel against its neighbour on the same electrode shaft.
| Identifier | signalstudio.bipolar |
|---|---|
| Category | preprocessing.spatial |
| Since | 0.2.0 |
Ports
| Port | Direction | Type | Notes |
|---|---|---|---|
in | input | Raw | |
out | output | Raw |
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
drop_last | bool | true | Drop the last contact of each shaft, which has no neighbour. |
Validation
Checked against an independent implementation on a real recording.
| Reference | mne.set_bipolar_reference |
|---|---|
| Dataset | ds004457 sub-1 |
| Agreement | r = 1.00, max delta 4.7e-9 |
Confirm these figures against a current harness run before citing them. How validation works
Manifest
card.json
{
"id": "signalstudio.bipolar",
"name": "Bipolar Reference",
"category": "preprocessing.spatial",
"inputs": [
{
"id": "in",
"type": "Raw"
}
],
"outputs": [
{
"id": "out",
"type": "Raw"
}
],
"params": {
"drop_last": {
"type": "bool",
"default": true,
"doc": "Drop the last contact of each shaft, which has no neighbour."
}
}
}