bidsaid.events.EPrimeEventExtractor.extract_onsets

EPrimeEventExtractor.extract_onsets(scanner_start_time=None)

Extract the onset times for each event.

Onset is calculated as the difference between the event time and the scanner start time.

Parameters

scanner_start_timefloat, int, or None, default=None

The scanner start time. Used to compute onset relative to the start of the scan.

Note

Does not need to be given if trigger_column_name was set.

Returns

list[float]

A list of onset times for each event.