Skip to main content

A module for real-time data analysis with MNE.

Project description

MNE-realtime

[!WARNING] This project is discontinued in favor of MNE-LSL. At the moment, MNE-LSL replaces the LSLClient and does not yet support the FieldTrip buffer.

This is a package for realtime analysis of MEG/EEG data with MNE. The documentation can be found here:

Dependencies

Installation

We recommend the Anaconda Python distribution. We require that you use Python 3. You may choose to install mne-realtime via pip.

Besides numpy and scipy (which are included in the standard Anaconda installation), you will need to install the most recent version of MNE using the pip tool:

$ pip install -U mne

Then install mne-realtime:

$ pip install https://api.github.com/repos/mne-tools/mne-realtime/zipball/main

These pip commands also work if you want to upgrade if a newer version of mne-realtime is available. If you do not have administrator privileges on the computer, use the --user flag with pip.

Quickstart

info = mne.io.read_info(op.join(data_path, 'MEG', 'sample',
                        'sample_audvis_raw.fif'))
with FieldTripClient(host='localhost', port=1972,
                     tmax=30, wait_max=5, info=info) as rt_client:
    rt_epochs = RtEpochs(rt_client, event_id, tmin, tmax, ...)
    rt_epochs.start()
    for ev in rt_epochs.iter_evoked():
        epoch_data = ev.data

    # or alternatively, get last n_samples
    rt_epoch = rt_client.get_data_as_epoch(n_samples=500)
    continuous_data = rt_epoch.get_data()

The FieldTripClient supports multiple vendors through the FieldTrip buffer. It can be replaced with other clients such as LSLClient. See API for a list of clients.

Bug reports

Use the github issue tracker to report bugs.

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

mne-realtime-0.3.0.tar.gz (50.4 kB view details)

Uploaded Source

Built Distribution

mne_realtime-0.3.0-py3-none-any.whl (44.7 kB view details)

Uploaded Python 3

File details

Details for the file mne-realtime-0.3.0.tar.gz.

File metadata

  • Download URL: mne-realtime-0.3.0.tar.gz
  • Upload date:
  • Size: 50.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for mne-realtime-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5ece5d8be166c45455aa4e289261a4086f2882bf79f48f9cd206019f902b817c
MD5 1950049c0244bb8cf0e1645e6ab9f2ed
BLAKE2b-256 e9fcf3c396ef2d675f0545e07e7a625564a3dd11e8ebb5291bbf4858b512de54

See more details on using hashes here.

File details

Details for the file mne_realtime-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: mne_realtime-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 44.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for mne_realtime-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 352a022412a411b444ee9f6126f0025c0d587f1383ee11d3ea3bebd2ea4df185
MD5 d992d5d98be74703a358d4ec290f7aa8
BLAKE2b-256 5870bca23bdd9ac406400c778825cf56fe629bfbb49f5c77c2f95dc8ce715aaf

See more details on using hashes here.

Supported by

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