ROIVolWindow-class: ROIVolWindow
In bbuchsbaum/neuroim2: Data Structures and IO for Neuroimaging Data with an Emphasis on Functional Magnetic Resonance Imaging (FMRI)
ROIVolWindow-class R Documentation
ROIVolWindow
Description
A class representing a spatially windowed volumetric region of interest (ROI) in a brain image, derived from a larger parent ROI.
Slots
parent_indexAn integer representing the 1D index of the center voxel in the parent space.
center_indexAn integer representing the location in the coordinate matrix of the center voxel in the window.
coordsA matrix containing the 3D coordinates of the voxels within the ROI. Each row represents a voxel coordinate as (x, y, z).
.DataA numeric vector containing the data values associated with each voxel in the ROI. The length of this vector should match the number of rows in the coords matrix.
Validity
An object of class ROIVolWindow is considered valid if:
- The coords slot is a matrix with 3 columns.
- The .Data slot is a numeric vector.
- The length of the .Data vector is equal to the number of rows in the coords matrix.
bbuchsbaum/neuroim2 documentation built on April 20, 2024, 4:20 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| ROIVolWindow-class | R Documentation |
ROIVolWindow
Description
A class representing a spatially windowed volumetric region of interest (ROI) in a brain image, derived from a larger parent ROI.
Slots
parent_indexAn
integerrepresenting the 1D index of the center voxel in the parent space.center_indexAn
integerrepresenting the location in the coordinate matrix of the center voxel in the window.coordsA
matrixcontaining the 3D coordinates of the voxels within the ROI. Each row represents a voxel coordinate as (x, y, z)..DataA
numericvector containing the data values associated with each voxel in the ROI. The length of this vector should match the number of rows in thecoordsmatrix.
Validity
An object of class ROIVolWindow is considered valid if:
- The coords slot is a matrix with 3 columns.
- The .Data slot is a numeric vector.
- The length of the .Data vector is equal to the number of rows in the coords matrix.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.