Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

nilearn.regions.img_to_signals_maps¶

nilearn.regions.img_to_signals_maps(imgs, maps_img, mask_img=None)[source]¶

Extract region signals from image.

This function is applicable to regions defined by maps.

Parameters:

imgslist of Niimg-like objects: See Input and output: neuroimaging data representation. Input images.
maps_imgNiimg-like object: See Input and output: neuroimaging data representation. Regions definition as maps (array of weights). shape: imgs.shape + (region number, )
mask_imgNiimg-like object, default=None: See Input and output: neuroimaging data representation. Mask to apply to regions before extracting signals. Every point outside the mask is considered as background (i.e. outside of any region).

Returns:

region_signalsnumpy.ndarray: Signals extracted from each region. Shape is: (scans number, number of regions intersecting mask)
mapslist of int: maps_img[…, labels[n]] is the region that has been used to extract signal region_signals[:, n].