newdata_xifti: Replace the data in a '"xifti"'

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

Replace the data in a "xifti"

Description

Replace the data in a "xifti" with new data from a data matrix.

Usage

newdata_xifti(xifti, newdata, newnames = NULL, subcortex_by_bs = FALSE)

Arguments

xifti	A "xifti" object.
newdata	The V \times T matrix of data values to replace those in xifti with. The left cortex vertices should be at the top, right cortex vertices in the middle, and subcortex vertices at the bottom (when present). If newdata is instead a V \times Q matrix where Q is not T, then any column names or label tables will be removed. (A "dlabel" will be converted to a "dscalar".) Can also be a length-one vector to set all values equally.
newnames	Replaces the names in the xifti. If NULL (default), keep the original names, except if the number of columns in newdata doesn't match that of xifti, in which case no names will be used.
subcortex_by_bs	If subcortical data is being provided in newdata, are the locations ordered by brain structure? Default: FALSE. The "xifti" data matrix is not ordered by brain structure, but CIFTI files and most other CIFTI packages do sort subcortical data by brain structure first, and then array index second.

Details

If the "xifti" has V grayordinates and T measurements\, newdata should be a V \times Q matrix. If Q is not equal to T, then any column names or label tables will be removed. (A "dlabel" will be converted to a "dscalar".)

Value

The new "xifti"

See Also

Other manipulating xifti: add_surf(), apply_parc(), apply_xifti(), combine_xifti(), convert_xifti(), impute_xifti(), merge_xifti(), move_to_mwall(), move_to_submask(), remap_cifti(), remove_xifti(), resample_cifti(), resample_cifti_from_template(), scale_xifti(), select_xifti(), set_names_xifti(), smooth_cifti(), transform_xifti()

ciftiTools documentation built on April 4, 2025, 1:09 a.m.