eelbrain.plot._brain_object.Brain.add_mask

Brain.add_mask(self, source, color=(0, 0, 0, 0.5), smoothing_steps=None, alpha=None, subjects_dir=None)

Add a mask shading areas that are not included in an NDVar

Parameters:

source : SourceSpace

SourceSpace.

color : matplotlib color

Mask color, can include alpha (defauls is black with alpha=0.5: (0, 0, 0, 0.5)).

smoothing_steps : scalar (optional)

Smooth transition at the mask’s border. If smoothing, the mask is added as data layer, otherwise it is added as label.

alpha : scalar

Alpha for the mask (supercedes alpha in color).

subjects_dir : str

Use this directory as the subjects directory.