SparseNeuroVecSource-class: SparseNeuroVecSource

Description Usage Arguments Slots Examples

Description

A class that is used to produce a SparseNeuroVec instance

constructs a SparseNeuroVecSource object

Usage

1
SparseNeuroVecSource(meta_info, indices = NULL, mask)

Arguments

meta_info

an object of class MetaInfo

indices

an optional vector of 1D indices the subset of volumes to load

mask

a logical 3D array, a logical 1D vector or a LogicalNeuroVol

Slots

mask

the subset of voxels that will be stored in memory

Examples

1
2
3
4
5
 mask_name <- system.file("extdata", "global_mask.nii", package="neuroim2")
 vec_name <- system.file("extdata", "global_mask_v5.nii", package="neuroim2")
 mask <- as.logical(read_vol(mask_name))

 src <- SparseNeuroVecSource(read_header(vec_name), mask=mask)

bbuchsbaum/neuroim2 documentation built on Oct. 12, 2019, 6:54 a.m.