Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

3.4.1. nistats.experimental_paradigm.check_events

nistats.experimental_paradigm.check_events(events)

Test that the events data describes a valid experimental paradigm

It is valid if the events data has an ‘onset’ key.

Parameters

eventspandas DataFrame

Events data that describes a functional experimental paradigm.

Returns

trial_typearray of shape (n_events,), dtype=’s’

Per-event experimental conditions identifier. Defaults to np.repeat(‘dummy’, len(onsets)).

onsetarray of shape (n_events,), dtype=’f’

Per-event onset time (in seconds)

durationarray of shape (n_events,), dtype=’f’

Per-event durantion, (in seconds) defaults to zeros(n_events) when no duration is provided

modulationarray of shape (n_events,), dtype=’f’

Per-event modulation, (in seconds) defaults to ones(n_events) when no duration is provided