neurocaps.typing.SubjectTimeseries

SubjectTimeseries

Type Definition for the Subject Timeseries Dictionary Structure.

A dictionary mapping subject IDs to their run IDs and their associated timeseries (TRs x ROIs) as a NumPy array. The structure is as follows:

subject_timeseries = {
        "101": {
            "run-0": np.array(shape=[TR, ROIs]),
            "run-1": np.array(shape=[TR, ROIs]),
            "run-2": np.array(shape=[TR, ROIs]),
        },
        "102": {
            "run-0": np.array(shape=[TR, ROIs]),
            "run-1": np.array(shape=[TR, ROIs]),
        }
    }

Important

The run IDs must be in the form “run-{0}” (e.g. “run-0” or “run-zero”).

Added in version 0.23.6.