Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] Show warning when Scoreboard / AxonMap models are used with implant.z > 0 #368

Merged
merged 1 commit into from May 11, 2021

Conversation

mbeyeler
Copy link
Member

Although implants have an electric_potential method, ScoreboardModel and AxonMapModel do not make use of it. Therefore, setting an electrode's z value > 0 does not have an effect on the model output. This is now being communicated to the user with a warning message (closes issue #169)

@mbeyeler mbeyeler added this to the v0.7.1 milestone May 11, 2021
@mbeyeler mbeyeler linked an issue May 11, 2021 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented May 11, 2021

Codecov Report

Merging #368 (a735937) into master (bcccc7d) will increase coverage by 0.08%.
The diff coverage is 94.11%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #368      +/-   ##
==========================================
+ Coverage   93.90%   93.98%   +0.08%     
==========================================
  Files          85       85              
  Lines        7181     7220      +39     
==========================================
+ Hits         6743     6786      +43     
+ Misses        438      434       -4     
Flag Coverage Δ
unittests 93.98% <94.11%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pulse2percept/utils/testing.py 80.00% <57.14%> (-20.00%) ⬇️
pulse2percept/models/beyeler2019.py 96.48% <100.00%> (+0.14%) ⬆️
pulse2percept/models/tests/test_beyeler2019.py 100.00% <100.00%> (ø)
pulse2percept/stimuli/base.py 97.01% <100.00%> (ø)
pulse2percept/version.py 100.00% <100.00%> (ø)
pulse2percept/viz/argus.py 93.69% <100.00%> (+7.02%) ⬆️
pulse2percept/viz/tests/test_argus.py 100.00% <100.00%> (ø)

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 ca6ecaf...a735937. Read the comment docs.

@mbeyeler mbeyeler merged commit 9a1a22f into pulse2percept:master May 11, 2021
@mbeyeler mbeyeler deleted the warn-model-z0 branch May 11, 2021 20:23
mbeyeler added a commit that referenced this pull request Jun 22, 2021
* Increment version number

* [FIX] Axon map in Argus plotters (#366)

* fix axon map in Argus plotters

* fix typo

* fix more typos

* [FIX] Axon map plot for left eyes (#367)

* [DOC] Update release notes

* [FIX] Show warning when Scoreboard / AxonMap models are used with implant.z > 0 (#368)

* [ENH] Speed up AxonMap build (#369)

* replace np.insert with np.concatenate

* Update release notes

* [FIX] Axon map usability (#370)

* Raise ValueError when lambda is too small

* Add note in the docs about resetting parameters

* Fix axon map docs, refactor axon methods

* remove axon map legacy build

* Update release notes

* [ENH] Update Nanduri2012 data (#376)

* updated nanduri dataset

* Updated / added test cases

* Add docstring for new column

* Fixed docstring for new column

* [ENH] Speed up ElectrodeArray.plot() (#375)

* speed up implant.plot

* Update release notes

* update test

* [ENH] Add FadingTemporal model (#378)

* Add FadingTemporal model

* Fix docs and release notes

* [FIX] Percept plotting and animation (#379)

* fix plot method

* remove get_interval, use utils.unique instead

* Fix Matplotlib deprecation error

* [FIX] BVT24 electrode naming convention (#380)

* [ENH] Various performance enhancements (#382)

* speed up stim.compress()

* Speed up alphabetic electrode numbering

* fix typo

* fix contiguous error

* add new cython submodule

* refactor Nanduri Cython

* Refactor Horsager Cython

* Refactor Beyeler Cython

* add cumpow function

* [ENH] Various implant upgrades (#383)

* Update earray indexing

* fix is_charge_balanced

* add easy conversion from ImageStimulus, VideoStimulus to implant.stim

* Activate/deactivate electrodes

* [DOC] Fix CircleElectrodeArray

* [FIX] BarStimulus, GratingStimulus docs (#384)

* [ENH] Various stimulus upgrades (#385)

* Speed up VideoStimulus init

* Fix rgb2gray for a video that's already grayscale

* Speed up Stimulus init

* replace np.isclose with math.isclose for speedup

* Switch monotonic ValueError to warning

* Add video.trim()

* [FIX] Order of display items in implant plots (#386)

* add constants; fix np.bool deprecation warning

* adjust alpha of electrode plots

* Don't expose constants at the module level

* [FIX] plot_sinusoidal example

* [FIX] Add docstrings for constants

* Prepare Release 0.7.1 (#387)

* Prepare Release 0.7.1

* Add MANIFEST.in

Co-authored-by: Jacob Granley <jgranley@ucsb.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Electrode-retina distance for ScoreboardModel, AxonMapModel
2 participants