square_roi

This function creates a square region of interest (ROI) in a 3D volume, where the z-dimension is fixed
at one voxel coordinate. The ROI is defined within a given NeuroVol or NeuroSpace instance.

A collection of data structures and methods for handling volumetric
brain imaging data, with a focus on functional magnetic resonance imaging (fMRI). Provides efficient
representations for three-dimensional and four-dimensional neuroimaging data through sparse and dense array
implementations, memory-mapped file access for large datasets, and
spatial transformation capabilities. Implements methods for image resampling,
spatial filtering, region of interest analysis, and connected component labeling. General introduction
to fMRI analysis can be found in Poldrack et al. (2024, "Handbook of functional MRI data analysis",
<ISBN:9781108795760>).

Bradley Buchsbaum

neuroim2

Data Structures for Brain Imaging Data

square_roi function

<dl><dt>bvol</dt>
<dd>A <code>NeuroVol</code> or <code>NeuroSpace</code> instance representing the 3D volume or space.</dd>
<dt>centroid</dt>
<dd>A numeric vector of length 3, representing the center of the square ROI in voxel coordinates.</dd>
<dt>surround</dt>
<dd>A non-negative integer specifying the number of voxels on either side of the central voxel.</dd>
<dt>fill</dt>
<dd>An optional value or values to assign to the data slot of the resulting ROI. If not provided, no data will be assigned.</dd>
<dt>nonzero</dt>
<dd>A logical value indicating whether to keep only nonzero elements from <code>bvol</code>.
If <code>bvol</code> is a <code>NeuroSpace</code> instance, this argument is ignored.</dd>
<dt>fixdim</dt>
<dd>A logical value indicating whether the fixed dimension is the third, or z, dimension. Default is TRUE.</dd></dl>

Arguments

Create a square region of interest — square_roi

<dl>

<dt>bvol</dt>
<dd>A <code>NeuroVol</code> or <code>NeuroSpace</code> instance representing the 3D volume or space.</dd>


<dt>centroid</dt>
<dd>A numeric vector of length 3, representing the center of the square ROI in voxel coordinates.</dd>


<dt>surround</dt>
<dd>A non-negative integer specifying the number of voxels on either side of the central voxel.</dd>


<dt>fill</dt>
<dd>An optional value or values to assign to the data slot of the resulting ROI. If not provided, no data will be assigned.</dd>


<dt>nonzero</dt>
<dd>A logical value indicating whether to keep only nonzero elements from <code>bvol</code>.
If <code>bvol</code> is a <code>NeuroSpace</code> instance, this argument is ignored.</dd>


<dt>fixdim</dt>
<dd>A logical value indicating whether the fixed dimension is the third, or z, dimension. Default is TRUE.</dd>

</dl>

square_roi: Create a square region of interest

Description

Usage

Value

Arguments

Examples