Skip to main content

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 .EDF or .EEG files 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()

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 MNE installed 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

bipolar_explorer_mne-0.1.1.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bipolar_explorer_mne-0.1.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file bipolar_explorer_mne-0.1.1.tar.gz.

File metadata

  • Download URL: bipolar_explorer_mne-0.1.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bipolar_explorer_mne-0.1.1.tar.gz
Algorithm Hash digest
SHA256 964ea1b13ff11f173d48671c787ab2df392419d8b20b4d7a88d9a86afcff34e4
MD5 bfa37c60d42cbe340b5c7951a9026622
BLAKE2b-256 6e208958fb971444812fdecec56aa27e937199e2a65914e4f1b88e9585751ec8

See more details on using hashes here.

Provenance

The following attestation bundles were made for bipolar_explorer_mne-0.1.1.tar.gz:

Publisher: release.yml on anascacais/BipolarExplorerMNE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bipolar_explorer_mne-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for bipolar_explorer_mne-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08297b663fd5b3f28467d3f591a020c881e7cc9b4dea1c6f1bf70e24e7c230c5
MD5 29d0619547b6c192dd4480c0b502cfff
BLAKE2b-256 ecabc4ba90070b427f0e1ade501fa6663bac442ab0fc27a1b6c1610f2b73ed99

See more details on using hashes here.

Provenance

The following attestation bundles were made for bipolar_explorer_mne-0.1.1-py3-none-any.whl:

Publisher: release.yml on anascacais/BipolarExplorerMNE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page