Function: searchlightCoords()

function searchlightCoords(
   mask, 
   radius, 
   options?): Promise<LazyList<Float32Array<ArrayBufferLike>>>;

Defined in: src/searchlight/searchlight.ts:146

Create an exhaustive searchlight iterator for voxel coordinates.

This function generates an exhaustive searchlight iterator that returns voxel coordinates for each searchlight sphere within the provided mask.

Parameters

mask

| NeuroVol | LogicalNeuroVol

A NeuroVol object representing the brain mask

radius

number

The radius (in mm) of the spherical searchlight

options?

SearchlightOptions = {}

Searchlight options

Returns

Promise<LazyList<Float32Array<ArrayBufferLike>>>

A lazy list of coordinate arrays