API#
neurocaps.exceptions - Exceptions#
Module containing custom exceptions.
Added in version 0.22.2.
BIDS File Querying Exception. |
|
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), reporting quality control metrics (number of frames scrubbed or interpolated) as
well as for pickling (serializing) and visualizing the extracted data.
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().
Co-Activation Patterns (CAPs) Class. |
Perform Participant-wise Dtype Conversion. |
|
Merge Participant Timeseries Across Multiple Sessions or Tasks. |
|
Perform Participant-wise Timeseries Standardization Within Runs. |
|
Generate and Visualize the Averaged Transition Probabilities. |
neurocaps.typing - Types#
Module containing custom types.
Added in version 0.23.6.
Type Definition for the Subject Timeseries Dictionary Structure. |
|
Type Definition for the Parcellation Configurations. |
|
Type Definition for the Schaefer Parcellation Configurations. |
|
Type Definition for the AAL Parcellation Configurations. |
|
Type Definition for the Parcellation Approaches. |
|
Type Definition for the Schaefer Parcellation Approach. |
|
Type Definition for the AAL Parcellation Approach. |
|
Type Definition for the Custom Parcellation Approach. |
|
Type Definition for Hemisphere Mapping in Custom Parcellation Regions. |