simulate_subject_timeseries#

neurocaps.utils.simulate_subject_timeseries(n_subs=8, n_runs=3, shape=(400, 100))[source]#

Generate Simulated Subject Timeseries Data.

Creates a subject timeseries dictionary with randomly generated values.

Added in version 0.34.1.

Parameters:
  • n_subs (int, default=8) – Number of subjects.

  • n_runs (int, default=3) – Number of runs for each subject.

  • shape (tuple, default=(400, 100)) – Shape of the generated timeseries data in the form (rows, columns).

Returns:

SubjectTimeseries – A dictionary mapping subject IDs to their run IDs and their associated timeseries (TRs x ROIs) as a NumPy array. Refer to documentation for SubjectTimeseries in the “See Also” section for an example structure.

See also

neurocaps.typing.SubjectTimeseries

Type definition for the subject timeseries dictionary structure. (See: SubjectTimeseries Documentation)