pulse2percept.stimuli.samples.ucsb_surf

pulse2percept.stimuli.samples.ucsb_surf(resize=None, electrodes=None, metadata=None, as_gray=False)[source]

UCSB coastline video frame

Load a 476x845x3 RGB frame of the UCSB coastline, as a naturalistic image stimulus.

The frame comes from Towards a Smart Bionic Eye, produced by the National Library of Medicine / National Institutes of Health. As a U.S. government work it is in the public domain in the United States, and is therefore not covered by pulse2percept’s BSD license; metadata carries the requested attribution.

Added in version 0.11.0.

Parameters:

  • resize ((height, width) or None, optional) – A tuple specifying the desired height and the width of the image stimulus.

  • electrodes (int, string or list thereof; optional) –

    Optionally, you can provide your own electrode names. If none are given, each pixel is named after its place in the image: a letter for the row, a number for the column, and a suffix for the color channel (e.g. ‘A1’, ‘C12’, ‘A1_R’).

    Note

    The number of electrode names provided must match the number of pixels in the (resized) image.

  • metadata (dict, optional) – Additional stimulus metadata can be stored in a dictionary. Keys given here override the attribution defaults above.

  • as_gray (bool, optional) – Flag whether to convert the image to grayscale.

Returns:

stim

Return type:

ImageStimulus

Examples

>>> from pulse2percept.stimuli import samples
>>> samples.ucsb_surf().img_shape
(476, 845, 3)