components.stimulus API

class nsds_lab_to_nwb.components.stimulus.mark_manager.MarkManager(rec_manager, stim_configs, use_tdt_mark_events=False)

Bases: object

get_mark_events(mark_events_input, mark_data, mark_rate)

get_mark_track()

class nsds_lab_to_nwb.components.stimulus.stimulus_originator.StimulusOriginator(rec_manager, dataset, metadata)

Bases: object

make(nwb_content)

class nsds_lab_to_nwb.components.stimulus.trials_manager.TrialsManager(block_name, stim_configs)

Bases: object

add_trials(nwb_content, mark_events, rec_end_time)

get_audio_start_time()

class nsds_lab_to_nwb.components.stimulus.wav_manager.WavManager(stim_lib_path, stim_configs)

Bases: object

get_stim_wav()

load_stim_from_wav_file()

class nsds_lab_to_nwb.components.stimulus.tokenizers.base_tokenizer.BaseTokenizer(block_name, stim_configs)

Bases: object

Base Tokenizer class for auditory stimulus data

tokenize(mark_events, rec_end_time)

class nsds_lab_to_nwb.components.stimulus.tokenizers.single_tokenizer.SingleTokenizer(block_name, stim_configs)

Bases: nsds_lab_to_nwb.components.stimulus.tokenizers.base_tokenizer.BaseTokenizer

Tokenize into a single stimulus trial, with possible baseline trials before/after. Suitable for DMR stimulus or baseline (no stimulus) blocks.

class nsds_lab_to_nwb.components.stimulus.tokenizers.timit_tokenizer.TIMITTokenizer(block_name, stim_configs)

Bases: nsds_lab_to_nwb.components.stimulus.tokenizers.base_tokenizer.BaseTokenizer

Tokenize into TIMIT stimulus trials.

nsds_lab_to_nwb.components.stimulus.tokenizers.timit_tokenizer.timit_stimulus_values(file_path)

adapted from mars.configs.block_directory

Parameters

file_path (full path to a .txt file that contains a list of filenames) –

Returns

stim_vals – each item is a .wav file name in TIMIT.

Return type

list of str

class nsds_lab_to_nwb.components.stimulus.tokenizers.tone_tokenizer.ToneTokenizer(block_name, stim_configs)

Bases: nsds_lab_to_nwb.components.stimulus.tokenizers.base_tokenizer.BaseTokenizer

Tokenize into discrete tone pip stimulus trials.

nsds_lab_to_nwb.components.stimulus.tokenizers.tone_tokenizer.tone_stimulus_values(mat_file_path)

adapted from mars.configs.block_directory

Parameters

mat_file_path (path) – full path to a .mat file that contains stim_values.

Returns

stim_vals – a 2D array with two columns (NOTE: changed from legacy behavior) stim_vals[:, 0] are the amplitudes, stim_vals[:, 1] are the frequencies of the tones.

Return type

ndarray (n, 2)

class nsds_lab_to_nwb.components.stimulus.tokenizers.wn_tokenizer.WNTokenizer(block_name, stim_configs)

Bases: nsds_lab_to_nwb.components.stimulus.tokenizers.base_tokenizer.BaseTokenizer

Tokenize into discrete white noise stimulus trials.