pulse2percept.stimuli.samples.bvl_cake

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

Bionic Vision Lab cake photograph

Load a 495x435 RGB photograph of a Bionic Vision Lab cake.

The photograph is distributed under the BSD 3-Clause license; attribution is included in metadata.

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.bvl_cake().img_shape
(495, 435, 3)