Stimulus

class compressed_kde.compressed_kde.decode.Stimulus

Bases: pybind11_object

Stimulus Occupancy class.

Parameters

• space (Space) – Description of stimulus space.

• grid (Grid) – Evaluation grid for stimulus space.

• stimulus_duration (float) – Duration (in seconds) of single stimulus.

• compression (float) – Compression threshold.

Attributes Summary

compression	Threshold for compression when merging new stimuli into distribution.
ndim	Dimensionality of stimulus space.
random_insertion	Whether new stimuli will be merged into the distribution in randomized order.
space	Stimulus space.
stimulus_duration	Duration (in seconds) of single stimulus.
stimulus_time	Total stimulus presentation time.

Methods Summary

add_stimuli(stimuli, repetitions)	Merge new stimuli into distribution.
load_from_hdf5(filename, path)	Load stimulus occupancy from hdf5 file.
logp()	Evaluate log probability of stimulus distribution on grid.
occupancy()	Evaluate stimulus occupancy on grid.
prob()	Evaluate probability of stimulus distribution on grid.
save_to_hdf5(filename, flags, path)	Save stimulus occupancy to hdf5 file.
save_to_yaml(path)	Save stimulus occupancy to YAML file.
to_yaml()	Represent stimulus occupancy as YAML.

Attributes Documentation

compression

Threshold for compression when merging new stimuli into distribution.

ndim

Dimensionality of stimulus space.

random_insertion

Whether new stimuli will be merged into the distribution in randomized order.

space

Stimulus space.

stimulus_duration

Duration (in seconds) of single stimulus.

stimulus_time

Total stimulus presentation time.

Methods Documentation

add_stimuli(stimuli, repetitions) → None

Merge new stimuli into distribution.

Parameters

• stimuli ((n,ndim) array) – Array of stimulus values.

• repetitions (int) – The number of repetitions for the stimuli.

static load_from_hdf5(filename, path) → StimulusOccupancy

Load stimulus occupancy from hdf5 file.

Parameters

• filename (str) – path to hdf5 file

• path (str) – path inside hdf5 file

Return type

StimulusOccupancy

logp() → array

Evaluate log probability of stimulus distribution on grid.

Return type

nd array

occupancy() → array

Evaluate stimulus occupancy on grid.

Return type

nd array

prob() → array

Evaluate probability of stimulus distribution on grid.

Return type

nd array

save_to_hdf5(filename, flags, path) → None

Save stimulus occupancy to hdf5 file.

Parameters

• filename (str) – path to hdf5 file

• flags (int) – flags for file creation

• path (str) – path inside hdf5 file

save_to_yaml(path) → None

Save stimulus occupancy to YAML file.

Parameters

path (string) – path tho YAML file

to_yaml() → str

Represent stimulus occupancy as YAML.

Return type

string