A tool for exploring bipolar montages in MNE files.
Project description
BipolarExplorerMNE
A simple Python package built on top of MNE-Python to visualize bipolar montages of non-EEG signals (e.g., ECG, EMG, EOG) from .EDF or .EEG files, even when channel names are inconsistent or messy.
🚀 Motivation
Working with physiological recordings from hospital systems often means dealing with inconsistently named or misconfigured channels. While EEG data typically follows the 10-20 naming convention, ECG and other physiological signals often don't — you'll find channel names like:
ECG-,ECG+E,Ecg-0,Ecg- ...and other unpredictable combinations.
On top of that, electrode placement can sometimes be reversed, making interpretation more difficult.
This package helps quickly visualize possible bipolar combinations between selected channels, so you can identify useful signals and confirm polarity before moving on to analysis.
📦 Features
- Load
.EDFor.EEGfiles using MNE - Visualize bipolar signals from non-EEG channels
- Interactive (plotly) plots to scroll and inspect signals
- Designed for manual exploration and verification
🔧 Installation
You can install the package via pip (if uploaded to PyPI) or directly from GitHub:
pip install bipolar-explorer-mne
or
pip install git+https://github.com/anascacais/BipolarExplorerMNE.git
Usage
from bipolar_explorer_mne.bipolar_explorer import BipolarExplorer
# Load the data
explorer = BipolarExplorer(filepath='test_file.edf')
# Optional: list all available channels
explorer.list_channels()
# Open the UI
bipolar_config, id = explorer.explore(extra_ui_info=['id'])
Notes
- This tool is primarily meant for channel exploration, not as an automated pipeline.
- You should still verify the actual electrode placements and channel meaning based on metadata or clinical notes when available.
- It assumes you have
MNEinstalled and working in your environment.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bipolar_explorer_mne-0.1.2.tar.gz.
File metadata
- Download URL: bipolar_explorer_mne-0.1.2.tar.gz
- Upload date:
- Size: 6.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16d7b940944ef86062ad75daf0cf79fe1bcc7bbac2c51317d846d7a77d9db7c4
|
|
| MD5 |
412b377f5e73c343822079b34611bb26
|
|
| BLAKE2b-256 |
616a5cbaff8e3345f91bc120c9789a975d164730e7be6700a65ea53dd3453df3
|
Provenance
The following attestation bundles were made for bipolar_explorer_mne-0.1.2.tar.gz:
Publisher:
release.yml on anascacais/BipolarExplorerMNE
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bipolar_explorer_mne-0.1.2.tar.gz -
Subject digest:
16d7b940944ef86062ad75daf0cf79fe1bcc7bbac2c51317d846d7a77d9db7c4 - Sigstore transparency entry: 200213239
- Sigstore integration time:
-
Permalink:
anascacais/BipolarExplorerMNE@96f8a140a47d99f88a083698f000ec4ba5c4c246 -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/anascacais
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@96f8a140a47d99f88a083698f000ec4ba5c4c246 -
Trigger Event:
release
-
Statement type:
File details
Details for the file bipolar_explorer_mne-0.1.2-py3-none-any.whl.
File metadata
- Download URL: bipolar_explorer_mne-0.1.2-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9dca2b6ee171099e96437e329b3b0c8bd10223d368655b708cd34a1705f3089
|
|
| MD5 |
d3948aee046c6f6cda3d6b5df8ada0d0
|
|
| BLAKE2b-256 |
8a90b38d2211b97856d5a1fcd39f2a97969daed5cc8e3c00983aa0aabbfef348
|
Provenance
The following attestation bundles were made for bipolar_explorer_mne-0.1.2-py3-none-any.whl:
Publisher:
release.yml on anascacais/BipolarExplorerMNE
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bipolar_explorer_mne-0.1.2-py3-none-any.whl -
Subject digest:
f9dca2b6ee171099e96437e329b3b0c8bd10223d368655b708cd34a1705f3089 - Sigstore transparency entry: 200213245
- Sigstore integration time:
-
Permalink:
anascacais/BipolarExplorerMNE@96f8a140a47d99f88a083698f000ec4ba5c4c246 -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/anascacais
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@96f8a140a47d99f88a083698f000ec4ba5c4c246 -
Trigger Event:
release
-
Statement type: