NeuroVecSource: NeuroVecSource

In bbuchsbaum/neuroim2: Data Structures and IO for Neuroimaging Data with an Emphasis on Functional Magnetic Resonance Imaging (FMRI)

NeuroVecSource

Description

This function constructs a NeuroVecSource object, which represents the source of a four-dimensional brain image.

Usage

NeuroVecSource(file_name, indices = NULL, mask = NULL)

Arguments

file_name	The name of the 4-dimensional image file.
indices	An optional integer vector specifying the subset of volume indices to load. If not provided, all volumes will be loaded.
mask	An optional logical array or NeuroVol object defining the subset of voxels to load. If provided, a SparseNeuroVecSource object will be created.

Details

If a mask is supplied, it should be a LogicalNeuroVol or NeuroVol instance. If the latter, then the mask will be defined by nonzero elements of the volume.

Value

An instance of the NeuroVecSource class.

bbuchsbaum/neuroim2 documentation built on Nov. 3, 2024, 9:31 a.m.