pulse2percept.viz

This module provides a number of visualization functions.

axon_map This module provides a number of visualization functions.
pulse2percept.viz.plot_axon_map(eye='RE', loc_od=(15.5, 1.5), n_bundles=100, ax=None, upside_down=False, annotate_quadrants=True)[source]

Plot an axon map

This function generates an axon map for a left/right eye and a given optic disc location.

Parameters:
  • eye (str) – Either ‘LE’ for left eye or ‘RE’ for right eye
  • loc_od ((x_od, y_od), optional, default: (15.5, 1.5)) – Location of the optic disc center (deg).
  • n_bundles (int, optional, default: 100) – Number of nerve fiber bundles to plot.
  • ax (matplotlib.axes._subplots.AxesSubplot, optional, default: None) – A Matplotlib axes object. If None given, a new one will be created.
  • upside_down (bool, optional, default: False) – Flag whether to plot the retina upside-down, such that the upper half of the plot corresponds to the upper visual field. In general, inferior retina == upper visual field (and superior == lower).
  • annotate_quadrants (bool, optional, default: True) – Flag whether to annotate the four retinal quadrants (inferior/superior x temporal/nasal).
pulse2percept.viz.plot_implant_on_axon_map(implant, loc_od=(15.5, 1.5), n_bundles=100, ax=None, upside_down=False, annotate_implant=True, annotate_quadrants=True)[source]

Plot an implant on top of the axon map

This function plots an electrode array on top of an axon map.

Parameters:
  • implant (p2p.implants.ProsthesisSystem) – A ProsthesisSystem object. If a stimulus is given, stimulating electrodes will be highlighted in yellow.
  • loc_od ((x_od, y_od), optional, default: (15.5, 1.5)) – Location of the optic disc center (deg).
  • n_bundles (int, optional, default: 100) – Number of nerve fiber bundles to plot.
  • ax (matplotlib.axes._subplots.AxesSubplot, optional, default: None) – A Matplotlib axes object. If None given, a new one will be created.
  • upside_down (bool, optional, default: False) – Flag whether to plot the retina upside-down, such that the upper half of the plot corresponds to the upper visual field. In general, inferior retina == upper visual field (and superior == lower).
  • annotate_implant (bool, optional, default: True) – Flag whether to label electrodes in the implant.
  • annotate_quadrants (bool, optional, default: True) – Flag whether to annotate the four retinal quadrants (inferior/superior x temporal/nasal).