brain_pipe.preprocessing.brain.link.BIDSStimulusInfoExtractor

class BIDSStimulusInfoExtractor(brain_path_key: str = 'data_path', event_info_key: str = 'event_info')

Bases: object

Extract BIDS compliant stimulus information from an events.tsv file.

__init__(brain_path_key: str = 'data_path', event_info_key: str = 'event_info')

Create a new BIDSStimulusInfoExtractor instance.

Parameters:

• brain_path_key (str) – The key of the brain data path in the data dict.

• event_info_key (str) – The key store the event information in the data dict.

Methods

__init__([brain_path_key, event_info_key])	Create a new BIDSStimulusInfoExtractor instance.
read_events(events_path)	Read events from a BIDS compliant events.tsv file.

read_events(events_path: str)

Read events from a BIDS compliant events.tsv file.

Parameters:

events_path (str) – The path to the events.tsv file.

Returns:

The extracted event information. Each dict contains the information of one row in the events.tsv file

Return type:

Sequence[Dict[str, Any]]