neurocaps.extraction.TimeseriesExtractor.timeseries_to_pickle

TimeseriesExtractor.timeseries_to_pickle(output_dir, filename=None)

Save the Extracted Subject Timeseries.

Saves the extracted timeseries stored in the self.subject_timeseries dictionary (obtained from running self.get_bold) as a pickle file. This allows for data persistence and easy conversion back into dictionary form for later use.

Parameters:

• output_dir (os.PathLike) -- Directory to save self.subject_timeseries dictionary as a pickle file. The directory will be created if it does not exist.

• filename (str or None, default=None) --

  Name of the file with or without the "pkl" extension.

  Changed in version 0.19.0: file_name to filename

Returns:

self

Added in version 0.19.3.