sls

sls(
    lr,
    radius,
    space='onavg-ico32',
    center_space=None,
    mask=True,
    center_mask=None,
    return_dists=False,
    **kwargs,
)

Get a list of vertex indices for searchlight analysis.

Parameters

Name	Type	Description	Default
lr	(l, r, lr)	‘l’ for left hemisphere, ‘r’ for right hemisphere, ‘lr’ for both.	`'l'`
radius	int or float	The searchlight radius in mm.	required
space	str	The space in which the searchlights are defined. It should match the space of the data to be analyzed.	`'onavg-ico32'`
center_space	str	The space in which the searchlight centers are defined. If None, it will be the same as `space`.	`None`
mask	bool or ndarray	If True, use the default mask for the specified space. If False, no mask is applied. If an ndarray, it should be a boolean array indicating which vertices are included in the searchlight. The mask should match the mask applied to the data to be analyzed.	`True`
center_mask	bool or ndarray	If True, use the default mask for the center space. If False, no mask is applied. If an ndarray, it should be a boolean array indicating which vertices are included in the searchlight center.	`None`
return_dists	bool	If True, return the distances of the vertices in the searchlight to the center of the searchlight.	`False`
**kwargs	dict	Additional keyword arguments passed to the searchlight loading function.	`{}`

Name	Type	Description
sls	list of ndarray	Each entry is an ndarray of integers, which are the indices of the vertices in a searchlight.
dists	list of ndarray, optional	Each entry is an ndarray of float numbers, which are the distances between vertices in a searchlight and the center of the searchlight. Only returned if `return_dists` is True.