BirdSongToolbox.free_epoch_tools.get_event_related

BirdSongToolbox.free_epoch_tools.get_event_related(data, indices, fs, window, subtract_mean=None, \*\*kwargs)

Get all Instances of 1 Label from all Chunks

Parameters

data: list | shape [Chunks]->(Channels, Samples)

Neural Data

indiceslist | shape [Chunks]->[Events]

Onsets of the Labels to be Clipped

fsint

Sampling Frequency

indicesarray-like 1d of integers

Indices of event onset indices

windowtuple | shape (start, end)

Window (in ms) around event onsets, window components must be integer values

subtract_meantuple, optional | shape (start, end)

if present, subtract the mean value in the subtract_mean window for each trial from that trial’s time series (this is a trial-by-trial baseline)

Returns

events_matrixndarray | shape (Instances, Channels, Samples)

Neural Data in the User Defined Window for all Instances of each Label