brainspace.utils.parcellation.map_to_mask¶

brainspace.utils.parcellation.map_to_mask(values, mask, fill=0, axis=0)[source]¶

Assign data to mask.

Parameters:

values (ndarray, shape = (n_values,) or (n_samples, n_values)) – Source array of values.
mask (ndarray, shape = (n_mask,)) – Mask of boolean values. Data is mapped to mask. If values is 2D, the mask is applied according to axis.
fill (float, optional) – Value used to fill elements outside the mask. Default is 0.
axis ({0, 1}, optional) – If axis == 0 map rows. Otherwise, map columns. Default is 0.

Returns:

output (ndarray) – Values mapped to mask. If values is 1D, shape (n_mask,). When values is 2D, shape (n_samples, n_mask) if axis == 0 and (n_mask, n_samples) otherwise.