v0.8.0

Highlights

• New implants: BVT44 [Petoe2021] (PR #465)
• New models: BiphasicAxonMapModel [Granley2021] (PR #398) and Thompson2003Model [Thompson2003] (PR #448)
• New datasets: load_greenwald2009 [Greenwald2009] (PR #459) and load_perezfornos2012 [PerezFornos2012] (PR #457)
• New stimuli: BarStimulus, GratingStimulus (PR #310)
• Python 3.10 support (PR #479)

New features

• New gallery examples for visual field maps (PR #432), Nanduri dataset (PR #452), psychophysics stimuli (PR #480), and BiphasicAxonMapModel (PR #484)
• Crop method for ImageStimulus and VideoStimulus objects (PR #455)
• Specify number of OpenMP threads (PR #453)
• Ignore stimuli of deactivated electrodes (PR #444)
• Percepts can now have a limited number of gray levels (PR #443)
• Automatic stimulus reshaping for ImageStimulus and VideoStimulus objects (PR #434)
  ElectrodeGrid can now have different spacings in x and y direction (PR #430)
• Add new plotting styles for a grid’s plot method (PR #426, PR #433, PR #446)
• Additional options for scatter_correlation (PR #422)

Backwards-incompatible changes

• RetinalCoordTransform has been renamed to VisualFieldMap (PR #432)
• plot_axon_map was removed: Use pulse2percept.models.AxonMapModel.plot
• plot_implant_on_axon_map was removed: Use pulse2percept.implants.ProsthesisSystem.plot on top of :py:methpulse2percept.models.AxonMapModel.plot

v0.7.1

New features

• Add FadingTemporal, a generic phosphene fading model (PR #378)

Maintenance

• Various implant usability and speed upgrades (PR #375, PR #382, PR #383, PR #386)
• Various stimulus usability and speed upgrades (PR #382, PR #383, PR #384, PR #385)
• Refactor common Cython functions and move them into a utils._fast_math submodule (PR #382)
• Further speed up the AxonMapModel build process (PR #369)
• Improve documentation and usability of various AxonMapModel methods (PR #370)
• Disallow lambda<10 for AxonMapModel (PR #370)
• Show a warning when ScoreboardModel or AxonMapModel is used with a nonzero electrode-retina distance (PR #368)

Bug fixes

• Fix naming convention for BVT24 electrodes (PR #380)
• Fix issues with plotting and animating Percept (PR #379)
• Fix inconsistencies and missing parameters in the [Nanduri2012] dataset (PR #376)
• Fix pulse2percept.models.AxonMapModel.plot for left eyes (PR #367)
• Fix axon map visualization in plot_argus_phosphenes (PR #366)

v0.7.0

Highlights

• New implants: PRIMA, PRIMA75, PRIMA55, PRIMA40 (PR #188)
• New electrodes: SquareElectrode, HexElectrode, PhotovoltaicPixel (PR #188, PR #193)
• New stimuli: ImageStimulus and VideoStimulus (PR #196, PR #220, PR #221, PR #356), BarStimulus and GratingStimulus (PR #323)
• New datasets: load_nanduri2012 (PR #250)
• New model selection subpackage (PR #311)
• 100x speedup of building AxonMapModel (PR #331)
• OpenMP support (PR #260)
• Python 3.9 support (PR #348)

Backward-incompatible changes

• Implants rotation angles are now speicified in degrees, not radians (PR #357)
• pulse2percept now requires Matplotlib 3.0.2 or newer (PR #223)
• FFMPEG and scikit-video dependencies have been removed (PR #196)
• TimeSeries has been removed. Please use Stimulus instead
• LegacyMonophasicPulse, LegacyBiphasicPulse and LegacyPulseTrain have been removed. Use their equivalents without the “Legacy” prefix.

v0.6.0

Highlights

• New API (PR #96, PR #174, PR #178)
• New implants: BVA24 (PR #161)
• New models: ScoreboardModel (PR #96), AxonMapModel (PR #96), Nanduri2012Model (PR #168), Horsager2009Model (PR #180)
• New stimuli: BiphasicPulseTrain, AsymmetricBiphasicPulse, AsymmetricBiphasicPulseTrain (PR #178)
• New percepts subpackage (PR #174)
• New datasets subpackage (PR #167)
• New build process: Compile code and run tests via Makefile (PR #96)
• Documentation now includes a tutorial, user guide, developer’s guide, and a gallery

Backward-incompatible changes

• Times are now specified in milliseconds.
• The Simulation object has been removed. Please directly instantiate a model instead.
• pulse2percept.retina: use models instead
• pulse2percept.files: use io instead

Contributions

Big thanks to all contributors, including @DylanLin29, @jonluntzel, @ezgirmak, @garethgeorge.

v0.5.2

Bug fix:

• Restores Nanduri2012 fast Cython implementation

v0.5.1

Bug fixes:

• Fix "Cannot determine Numba type" error in center_vector
• Horsager2009 does now respect use_jit option
• Nanduri2012 now allows switch between cython/fft

v0.5.0

Highlights:

• Support for Python 3.5 - 3.7 on Linux, Windows, macOS (PR #129, #130)
• New pulse2percept.viz module (PR #84)
• Support for the AlphaIMS implant (PR #87)
• New contribution guidelines (PR #92)
• New issue templates (PR #93)
• New code of conduct (PR #95)
• Host documentation on https://pulse2percept.readthedocs.io.

Bug fixes

• Fix nasal/temporal labeling for left eyes (commit 9c3bddc)
• Fix plot_fundus for left eyes (commit a6ffdbc)
• Fix scipy.special.factorial (commit c9631ae)

v0.4.3

• Cython integration: Implements the Nanduri model using finite differences in Cython

v0.3

• New, faster axon map calculation
• Better plotting
• Add left eye / right eye support

v0.2

release v0.2.0

fix doc version number