pulse2percept.plotting.argus

plot_argus_phosphenes(), plot_argus_simulated_phosphenes()

Functions

plot_argus_phosphenes(data[, argus, scale, ...])

Plots phosphenes centered over the corresponding electrodes

plot_argus_simulated_phosphenes(percepts, argus)

Plots simulated phosphenes centered over the corresponding electrodes
pulse2percept.plotting.argus.plot_argus_phosphenes(data, argus=None, scale=1.0, axon_map=None, show_fovea=True, ax=None, implant_position=None, implant_rotation=None)[source]

Plots phosphenes centered over the corresponding electrodes

Added in version 0.7.

Parameters:

  • data (pd.DataFrame) – The Beyeler2019 dataset, a subset thereof, or a DataFrame with identical organization (i.e., must contain columns ‘subject’, ‘image’, ‘xrange’, and ‘yrange’).

  • argus (ArgusI or) – ArgusII Either an Argus I or Argus II implant. If None, the data must contain an “implant_type_str” column naming the device, either “ArgusI” or “ArgusII”. Where it was implanted comes from implant_position and implant_rotation below.

  • scale (float) – Scaling factor to apply to the phosphenes

  • axon_map (AxonMapModel) – An instance of the axon map model to use for visualization.

  • show_fovea (bool) – Whether to indicate the location of the fovea with a square

  • ax (axis) – Matplotlib axis

  • implant_position ((x, y) or Quantity, optional) –

    Position of the device-local origin on the retina (um). Defaults to the dataset’s “implant_x”/”implant_y” columns where present, else 0.

    Added in version 0.11.0.

  • implant_rotation (float or Quantity, optional) –

    Array rotation (deg), positive counter-clockwise. Defaults to the dataset’s “implant_rot” column where present, else 0.

    Added in version 0.11.0.

pulse2percept.plotting.argus.plot_argus_simulated_phosphenes(percepts, argus, scale=1.0, axon_map=None, show_fovea=True, ax=None, implant_position=None, implant_rotation=None)[source]

Plots simulated phosphenes centered over the corresponding electrodes

Added in version 0.7.

Parameters:

  • percepts (Percept) – A Percept object containing multiple frames, where each frame is the percept produced by activating a single electrode.

  • argus (ArgusI or) – ArgusII Either an Argus I or Argus II implant

  • scale (float) – Scaling factor to apply to the phosphenes

  • axon_map (AxonMapModel) – An instance of the axon map model to use for visualization.

  • show_fovea (bool) – Whether to indicate the location of the fovea with a square

  • ax (axis) – Matplotlib axis

  • implant_position ((x, y) or Quantity, optional) –

    Position of the device-local origin on the retina (um). Defaults to 0.

    Added in version 0.11.0.

  • implant_rotation (float or Quantity, optional) –

    Array rotation (deg), positive counter-clockwise. Defaults to 0.

    Added in version 0.11.0.