applyMask: Applying a Mask ('BrcParcellation') To 'BrcFmri'

In cdgreenidge/brcbase:

Description

Given a BrcFmri instance (fmri) and BrcParcellation instance (parcellation), applyMask intersects fmri by parcellation. This means all the voxels in parcellation's that were 0 will be zero-ed out in fmri (i.e., the partition of that voxel will be set to 0). If no elements of any partition originally in fmri exist anymore after this procedure, its corresponding column in fmri will be removed. On the flip side, if there were voxel in parcellation that were non-zero, but its corresponding voxel in fmri is empty, the voxel will be assigned an entirely new parcellation in the output of applyMask, and its corresponding column in fmri$data2d will be the column of all 0's.

Usage

applyMask(fmri, parcellation)

Arguments

fmri	the BrcFmri instance
parcellation	the BrcParcellation instance of the same dimension as fmri

Details

Here, fmri and parcellation must have the same size.

We call this procedure applying a mask because this procedure does not respect the partitioning in parcellation. It only takes into account which voxels are zero and non-zero in parcellation.

Value

a new BrcFmri instance

cdgreenidge/brcbase documentation built on May 13, 2019, 2:40 p.m.