NeuroVecSource: NeuroVecSource

Description Usage Arguments Details Value

View source: R/neurovec.R

Description

Construct a NeuroVecSource object

Usage

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

Arguments

file_name

name of the 4-dimensional image file

indices

the subset of integer volume indices to load – if NULL then all volumes will be loaded

mask

image volume indicating the subset of voxels that will be loaded. If provided, function returns SparseNeuroVecSource

Details

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

Value

a instance deriving from NeuroVecSource


bbuchsbaum/neuroim2 documentation built on Oct. 15, 2019, 2:55 p.m.