API

neurocaps.exceptions - Exceptions

Module containing custom exceptions (available in versions >= 0.22.2).

exceptions.BIDSQueryError(message)

BIDS File Querying Exception.

neurocaps.extraction - Timeseries Extraction

Module containing the TimeseriesExtractor class for extracting timeseries data from preprocessed BIDS datasets (using pipelines such as fMRIPrep), as well as for pickling (serializing) and visualizing the extracted data.

extraction.TimeseriesExtractor([space, ...])

Timeseries Extractor.

neurocaps.analysis - Co-Activation Patterns (CAPs) Analysis

Module containing the CAP class for performing and visualizing CAPs analyses, as well as functions for changing dtype, merging, and standardizing timeseries data, and creating averaged transition probability matrices from the participant-wise transition probabilities dataframes created by CAP.calculate_metrics.

analysis.CAP([parcel_approach, groups])

Co-Activation Patterns (CAPs).

analysis.change_dtype(...[, return_dicts, ...])	Perform Participant-wise Dtype Conversion.
analysis.merge_dicts(subject_timeseries_list)	Merge Participant Timeseries Across Multiple Sessions or Tasks.
analysis.standardize(subject_timeseries_list)	Perform Participant-wise Timeseries Standardization Within Runs.
analysis.transition_matrix(trans_dict[, ...])	Generate and Visualize the Averaged Transition Probabilities.