ROIVecWindow-class

A class representing a spatially windowed, vector-valued volumetric region of interest (ROI) in a brain image.

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

ROIVecWindow-class function

<dl>
<dt><code>coords</code></dt>
<dd>A <code>matrix</code> containing the 3D coordinates of the voxels within the ROI. Each row represents a voxel coordinate as (x, y, z).</dd></dl>
<dt><code>.Data</code></dt>
<dd>A <code>matrix</code> containing the data values associated with each voxel in the ROI. Each row corresponds to a unique vector value, and the number of rows should match the number of rows in the <code>coords</code> matrix.</dd>
<dt><code>parent_index</code></dt>
<dd>An <code>integer</code> representing the 1D index of the center voxel in the parent space.</dd>
<dt><code>center_index</code></dt>
<dd>An <code>integer</code> representing the location in the coordinate matrix of the center voxel in the window.</dd>

Slots

An object of class <code>ROIVecWindow</code> is considered valid if:
- The <code>coords</code> slot is a matrix with 3 columns.
- The <code>.Data</code> slot is a matrix.
- The number of rows in the <code>.Data</code> matrix is equal to the number of rows in the <code>coords</code> matrix.

Validity

ROIVecWindow — ROIVecWindow-class

<dl>
<dt><code>coords</code></dt>
<dd>A <code>matrix</code> containing the 3D coordinates of the voxels within the ROI. Each row represents a voxel coordinate as (x, y, z).</dd>


<dt><code>.Data</code></dt>
<dd>A <code>matrix</code> containing the data values associated with each voxel in the ROI. Each row corresponds to a unique vector value, and the number of rows should match the number of rows in the <code>coords</code> matrix.</dd>


<dt><code>parent_index</code></dt>
<dd>An <code>integer</code> representing the 1D index of the center voxel in the parent space.</dd>


<dt><code>center_index</code></dt>
<dd>An <code>integer</code> representing the location in the coordinate matrix of the center voxel in the window.</dd>


</dl>

An object of class <code>ROIVecWindow</code> is considered valid if:
- The <code>coords</code> slot is a matrix with 3 columns.
- The <code>.Data</code> slot is a matrix.
- The number of rows in the <code>.Data</code> matrix is equal to the number of rows in the <code>coords</code> matrix.

ROIVecWindow-class: ROIVecWindow

Description

Arguments

Slots

Validity