BrainVectorSource: BrainVectorSource

Description Usage Arguments Details Value

View source: R/BrainVector.R

Description

Construct a BrainVectorSource object

Usage

1
BrainVectorSource(fileName, indices = NULL, mask = NULL)

Arguments

fileName

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 SparseBrainVectorSource

Details

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

Value

a instance deriving from BrainVectorSource


neuroim documentation built on May 2, 2019, 1:04 p.m.