is.3D_mask {ciftiTools}R Documentation

Validate a 3d binary mask

Description

Check if object is a 3D binary mask.

Usage

is.3D_mask(x)

Arguments

x

The putative subcortical mask.

Details

This is a helper function for is.xifti.

Requirements: the mask must be a boolean 3D array. TRUE should indicate voxels included in the mask, whereas FALSE should indicate voxels outside of it.

Value

Logical. Is x a valid subcortical mask?


[Package ciftiTools version 0.17.4 Index]