sappelhoff / pyprep

A Python implementation of the Preprocessing Pipeline (PREP) for EEG data
https://pyprep.readthedocs.io/en/latest/
MIT License
128 stars 30 forks source link

Always keep EEG data in Volts instead of converting to mV #102

Closed a-hurst closed 2 years ago

a-hurst commented 2 years ago

PR Description

This PR removes a bunch of unnecessary conversions back and forth between Volts and mV, likewise changing the units for a few user-facing EEG attributes (e.g. self.EEG_before_interpolation) in PrepPipeline from the EEGLAB standard of mV to the MNE standard of volts.

This should make the API less confusing for people used to working in the MNE world, avoid a bunch of unnecessary large matrix multiplication, and makes some other proposed API changes in #99 easier to implement.

Merge Checklist

codecov-commenter commented 2 years ago

Codecov Report

Merging #102 (8fe116a) into master (7ad292c) will decrease coverage by 0.00%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #102      +/-   ##
==========================================
- Coverage   99.04%   99.04%   -0.01%     
==========================================
  Files           7        7              
  Lines         736      734       -2     
==========================================
- Hits          729      727       -2     
  Misses          7        7              
Impacted Files Coverage Δ
pyprep/prep_pipeline.py 100.00% <100.00%> (ø)
pyprep/reference.py 99.18% <100.00%> (-0.02%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 7ad292c...8fe116a. Read the comment docs.

sappelhoff commented 2 years ago

Thanks @a-hurst!