pulse2percept.datasets.horsager2009

load_horsager2009

Functions

load_horsager2009([subjects, electrodes, ...])

Load data from [Horsager2009]
pulse2percept.datasets.horsager2009.load_horsager2009(subjects=None, electrodes=None, stim_types=None, shuffle=False, random_state=0)[source]

Load data from [Horsager2009]

Load the threshold data described in [Horsager2009]. Average thresholds were extracted from the figures of the paper using WebplotDigitizer.

Retinal implants:

Argus I

Subjects:

2

Number of samples:

552

Number of features:

21

The dataset includes the following features:

subject

Subject ID, S05-S06

implant

Argus I

electrode

Electrode ID, A1-F10

task

‘threshold’ or ‘matching’

stim_type

‘single_pulse’, ‘fixed_duration’, ‘variable_duration’, ‘fixed_duration_supra’, ‘bursting_triplets’, ‘bursting_triplets_supra’, ‘latent_addition’

stim_dur

Stimulus duration (ms)

stim_freq

Stimulus frequency (Hz)

stim_amp

Stimulus amplitude (uA)

pulse_type

‘cathodic_first’

pulse_dur

Pulse duration (ms)

interphase_dur

Interphase gap (ms)

delay_dur

Stimulus delivered after delay (ms)

ref_stim_type

Reference stimulus type (‘single_pulse’, …)

ref_freq

Reference stimulus frequency (Hz)

ref_amp

Reference stimulus amplitude (uA)

ref_amp_factor

Reference stimulus amplitude factor (xThreshold)

ref_pulse_dur

Reference stimulus pulse duration (ms)

ref_interphase_dur

Reference stimulus interphase gap (ms)

theta

Temporal model output at threshold (a.u.)

source

Figure from which data was extracted

Some stimulus types require a reference stimulus. For example, ‘bursting_triplets_supra’ were delivered at 2x or 3x threshold of a reference bursting triplet pulse. The parameters of the reference stimulus are given in ref_* fields.

Missing values are denoted by NaN.

Added in version 0.6.

Parameters:

  • subjects (str | list of strings | None, optional) – Select data from a subject or list of subjects. By default, all subjects are selected.

  • electrodes (str | list of strings | None, optional) – Select data from a single electrode or a list of electrodes. By default, all electrodes are selected.

  • stim_types (str | list of strings | None, optional) – Select data from a single stimulus type or a list of stimulus types. By default, all stimulus types are selected.

  • shuffle (boolean, optional) – If True, the rows of the DataFrame are shuffled.

  • random_state (int | numpy.random.RandomState | None, optional) – Determines random number generation for dataset shuffling. Pass an int for reproducible output across multiple function calls.

Returns:

data (pd.DataFrame) – The whole dataset is returned in a 552x21 Pandas DataFrame