move_from_submask: Move data locations from subcortex mask

In mandymejia/ciftiTools: Tools for Reading, Writing, Viewing and Manipulating CIFTI Files

Move data locations from subcortex mask

Description

Move subcortex mask locations into the subcortex data matrix by assigning them a specific value (e.g. NA).

Usage

move_from_submask(
  xifti,
  new_mask,
  value = NA,
  label_value = "Other",
  name = "Other",
  RGBA = c(1, 1, 1, 0)
)

Arguments

xifti	A "xifti" object.
new_mask	The new mask, of which the current mask should be a subset. (new_mask should have more TRUE values.) The new TRUE values will be moved to the subcortex data.
value	The value to assign the new locations. Default: NA.
label_value	The label value to assign the new locations. Default: "Other".
name, RGBA	Only used if the "xifti" has the dlabel intent and value is not an already-existing Key. This is the name to assign to the new key for the new locations, as well as a length-four numeric vector indicating the red, green, blue, and alpha values for the color to assign to the new key. These will be reflected in the updated label table. Note that RGBA values must all be in [0, 1]. Currently, only one name and set of RGBA values are supported, meaning that the out-of-mask subcortex locations will have the same Key, name, and color across all data columns in the "xifti". An error will occur if the Key already exists for some columns but not others. Defaults: "Other" for "name" and white with 0 alpha for RGBA.

Value

The "xifti" with re-organized data and subcortex masks

See Also

move_to_submask

unmask_cortex

mandymejia/ciftiTools documentation built on Feb. 1, 2025, 7:57 p.m.