API

Publicly available classes, functions, exceptions, types, and utility functions within NeuroCAPs.

neurocaps.exceptions.BIDSQueryError	BIDS File Querying Exception.
neurocaps.exceptions.NoElbowDetectedError	Elbow Method Failure Exception.
neurocaps.exceptions.UnsupportedFileExtensionError	Unsupported File Extension Exception.
neurocaps.extraction.TimeseriesExtractor	Timeseries Extractor Class.
neurocaps.analysis.CAP	Co-Activation Patterns (CAPs) Class.
neurocaps.analysis.change_dtype	Perform Participant-wise Dtype Conversion.
neurocaps.analysis.merge_dicts	Merge Participant Timeseries Across Multiple Sessions or Tasks.
neurocaps.analysis.standardize	Perform Participant-wise Timeseries Standardization Within Runs.
neurocaps.analysis.transition_matrix	Generate and Visualize the Averaged Transition Probabilities.
neurocaps.typing.SubjectTimeseries	Type Definition for the Subject Timeseries Dictionary Structure.
neurocaps.typing.ParcelConfig	Type Definition for the Parcellation Configurations.
neurocaps.typing.SchaeferParcelConfig	Type Definition for the Schaefer Parcellation Configurations.
neurocaps.typing.AALParcelConfig	Type Definition for the AAL Parcellation Configurations.
neurocaps.typing.ParcelApproach	Type Definition for the Parcellation Approaches.
neurocaps.typing.SchaeferParcelApproach	Type Definition for the Schaefer Parcellation Approach.
neurocaps.typing.AALParcelApproach	Type Definition for the AAL Parcellation Approach.
neurocaps.typing.CustomParcelApproach	Type Definition for the Custom Parcellation Approach.
neurocaps.utils.fetch_preset_parcel_approach	Fetches a Preset "Custom" Parcellation Approach.
neurocaps.utils.generate_custom_parcel_approach	Generate a "Custom" Parcellation Approach From a Tabular Metadata File.