Reference API
neuromaps.datasets
- Dataset fetchers
Functions for fetching datasets.
Functions to show all available annotations
List datasets available via |
|
Return available tags for querying annotations. |
Functions to fetch and describe the annotations
|
Download files for brain annotations matching requested variables. |
Return detailed descriptions for annotations as a pandas dataframe. |
Functions to fetch the atlases
|
Fetch specified atlas and density. |
|
Fetch CIVET surface atlas. |
Fetch fsaverage surface atlas. |
|
|
Fetch fsLR surface atlas. |
|
Fetch MNI152 atlas. |
|
Fetch regfusion inputs for mapping MNI152 to specified surface atlas. |
Fetch (and cache) all available atlases. |
|
|
Return filepath to specified atlas. |
neuromaps.images
- Image and surface handling
Functions for operating on images + surfaces.
Functions to load the images and surfaces
Load gifti file img. |
|
Load nifti file img. |
Functions to convert surfaces to GIFTI format
|
Update GIFTI images so label IDs are consecutive across hemispheres. |
|
Convert FreeSurfer-style annotation parcellation files to GIFTI images. |
|
Convert CIFTI dlabel file to GIFTI images. |
|
Convert CIVET obj surface file to GIFTI format. |
|
Convert FreeSurfer surf surface file to GIFTI format. |
|
Convert FreeSurfer morph data file to GIFTI format. |
Functions to work with surfaces
Generate average surface from input surfs. |
|
|
Interpolate data on src surface to trg surface. |
|
Calculate vertex areas from surface file. |
neuromaps.nulls
- Null models
Functions for computing null models.
Spatial permutation null models (for surface images only)
|
Generate null maps from data using method from [SN1]. |
|
Generate null maps from data using method from [SN1]. |
|
Generate null maps for parcellated data using method from [SN2]. |
|
Generate null maps for parcellated data using the Hungarian method ([SN3]). |
|
Generate null maps for parcellated data using method from [SN4]. |
|
Generate null maps for parcellated data using method from [SN5]. |
Parametric spatial null models (for volumetric and surface images)
|
Generate null maps for data using method from [SN6]. |
|
Generate null maps for data using method from [SN7] and [SN8]. |
|
Generate null maps for data using method from [SN9]. |
neuromaps.parcellate
- Parcellation utilities
Functionality for parcellating data.
|
Class for parcellating arbitrary volumetric / surface data. |
neuromaps.plotting
- Plotting functions
Functionality for plotting.
|
Plot data on template surface. |
neuromaps.points
- Triangle mesh utilities
Functions for working with triangle meshes + surfaces.
|
Construct adjacency graph from surf. |
Calculate surface distance for vertices in surface. |
neuromaps.resampling
- Resampling workflows
Functions for comparing data.
|
Resample images src and trg to same space/density with resampling method. |
neuromaps.stats
- Statistical functions
Functions for statistical analyses.
|
Compare images src and trg. |
|
Generate non-parameteric p-value of a and b for metric. |
neuromaps.transforms
- Transformations between spaces
Functionality for transforming files between spaces.
Volume-to-surface transformations
|
Project img in MNI152 space to CIVET surface. |
Project img in MNI152 space to fsaverage surface. |
|
|
Project img in MNI152 space to fsLR surface. |
Volume-to-volume transformations
|
Resample img to target image (if supplied) or target resolution. |
Surface-to-surface transformations
|
Resample data on CIVET surface to the fsLR surface. |
|
Resample data on fsLR surface to the CIVET surface. |
Resample data on CIVET surface to the fsaverage surface. |
|
Resample data on fsaverage surface to the CIVET surface. |
|
|
Resample data on CIVET surface to new density. |
Resample data on fsLR surface to the fsaverage surface. |
|
Resample data on fsaverage surface to the fsLR surface. |
|
|
Resample data on fsLR surface to new density. |
Resample data on fsaverage surface to new density. |