pulse2percept.datasets.nanduri2012

Functions

load_nanduri2012([electrodes, task, ...])

Load data from [Nanduri2012]

pulse2percept.datasets.nanduri2012.load_nanduri2012(electrodes=None, task=None, shuffle=False, random_state=0)[source]

Load data from [Nanduri2012]

Load the brightness and size rating data described in [Nanduri2012]. Datapoints were extracted from figure 4 of the paper using WebplotDigitizer.

The dataset includes the following features:

subject	Subject ID, S06
implant	Argus I
electrode	Electrode ID, A2, A4, B1, C1, C4, D2, D3, D4
task	‘rate’ or ‘size’
stim_class	“Nanduri2012”
stim_dur	Stimulus duration (ms)
freq	Stimulus frequency (Hz)
amp_factor	Stimulus amplitude ratio over threshold
brightness	Patient rated brightness compared to reference stimulus
size	Patient rated size compared to reference stimulus
ref_stim_class	“Nanduri2012”
ref_amp_factor	Amplitude factor (xTh) of reference pulse
ref_freq	Frequency (Hz) of reference pulse
pulse_dur	Pulse duration (ms)
pulse_type	‘cathodicFirst’
interphase_dur	Interphase gap (ms)
varied_param	Whether this trial is a part of ‘amp’ or ‘freq’ modulation

Added in version 0.7.

Parameters:

electrodes (str | list of strings | None, optional) – Select data from a single electrode or a list of electrodes. By default, all electrodes 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 – The whole dataset is returned in a 144x16 Pandas DataFrame

Return type:

pd.DataFrame