API

neurocaps.exceptions - Exceptions

Module containing custom exceptions.

Added in version 0.22.2.

BIDSQueryError	BIDS File Querying Exception.
NoElbowDetectedError	Elbow Method Failure 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.

TimeseriesExtractor

Timeseries Extractor Class.

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().

CAP	Co-Activation Patterns (CAPs) Class.

change_dtype	Perform Participant-wise Dtype Conversion.
merge_dicts	Merge Participant Timeseries Across Multiple Sessions or Tasks.
standardize	Perform Participant-wise Timeseries Standardization Within Runs.
transition_matrix	Generate and Visualize the Averaged Transition Probabilities.

neurocaps.typing - Types

Module containing custom types.

Added in version 0.23.6.

SubjectTimeseries	Type Definition for the Subject Timeseries Dictionary Structure.
ParcelConfig	Type Definition for the Parcellation Configurations.
SchaeferParcelConfig	Type Definition for the Schaefer Parcellation Configurations.
AALParcelConfig	Type Definition for the AAL Parcellation Configurations.
ParcelApproach	Type Definition for the Parcellation Approaches.
SchaeferParcelApproach	Type Definition for the Schaefer Parcellation Approach.
AALParcelApproach	Type Definition for the AAL Parcellation Approach.
CustomParcelApproach	Type Definition for the Custom Parcellation Approach.
CustomRegionHemispheres	Type Definition for Hemisphere Mapping in Custom Parcellation Regions.