enigmatoolbox.datasets.load_mask

enigmatoolbox.datasets.load_mask(name='midline', surface_name='fsa5', join=False)[source]

Load mask for surface template (authors: @OualidBenkarim, @saratheriver)

Parameters

  • name ({'midline'} or None, optional) – Region name. If ‘midline’, load mask for all cortex. Default is ‘midline’

  • surface_name ({'fsa5', 'fsa5_with_sctx', 'conte69'}) – Default is fsa5

  • join (bool, optional) – If False, return one array for each hemisphere. Otherwise, return a single array for both left and right hemispheres. Default is False

Returns

mask – Boolean masks for left and right hemispheres. If join == True, one mask with both hemispheres

Return type

tuple of ndarrays or ndarray