Function: cuboidROI()

function cuboidROI(
   vol, 
   centroid, 
   surround, 
   fill?, 
   nonzero?): ROIVolWindow;

Defined in: src/roi/ROI_factories.ts:118

Creates a cuboidal ROI centered at the given coordinates.

Parameters

vol

NeuroVol

The NeuroVol representing the volume

centroid

number[]

The center voxel coordinates [i, j, k]

surround

number | number[]

Number of voxels to surround the centroid in each dimension. Can be a single number (same for all dimensions) or an array of three numbers

fill?

number = 1

Optional value(s) to assign to the data slot. Defaults to 1

nonzero?

boolean = false

If true, only include voxels with non-zero values from the source volume

Returns

ROIVolWindow

An ROIVolWindow representing the cuboidal ROI