Interface: SearchlightOptions

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

Options for searchlight analysis

Properties

eager?

optional eager?: boolean;

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

Whether to eagerly compute the searchlight ROIs

---

nonzero?

optional nonzero?: boolean;

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

Whether to include only coordinates with nonzero values

---

clipToMask?

optional clipToMask?: boolean;

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

Whether neighbourhood members are restricted to nonzero mask voxels. Defaults to nonzero, so analyses selecting nonzero centres also stay within the mask. Set to false to retain the previous geometric sphere.

---

cores?

optional cores?: number;

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

Number of cores/workers to use for parallel computation

---

onProgress?

optional onProgress?: (progress) => void;

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

Progress callback

Parameters

progress

number

Returns

void