Learn R Programming

ciftiTools (version 0.6.1)

transform_xifti: Apply a univariate transformation to a "xifti" or pair of "xifti"s.

Description

Apply a univariate transformation to each value in a "xifti" or pair of "xifti"s. If a pair, they must share the same dimensions (brainstructures) and number of measurements.

Usage

transform_xifti(xifti, FUN, xifti2 = NULL, ...)

# S3 method for xifti +(xifti, xifti2)

# S3 method for xifti -(xifti, xifti2)

# S3 method for xifti *(xifti, xifti2)

# S3 method for xifti ^(xifti, xifti2)

# S3 method for xifti %%(xifti, xifti2)

# S3 method for xifti %/%(xifti, xifti2)

# S3 method for xifti /(xifti, xifti2)

# S3 method for xifti abs(x)

# S3 method for xifti sign(x)

# S3 method for xifti sqrt(x)

# S3 method for xifti floor(x)

# S3 method for xifti ceiling(x)

# S3 method for xifti round(x, digits = 0)

# S3 method for xifti exp(x)

# S3 method for xifti log(x, base = exp(1))

Arguments

xifti

The xifti

FUN

The function. If xifti2 is not provided, it should be a univariate function like log or sqrt. If xifti2 is provided, it should take in two arguments, like `+` or pmax.

xifti2

The second xifti, if applicable. Otherwise, NULL (default)

...

Additional arguments to FUN

x

The "xifti"

digits

The number of digits to round by

base

The log base

Value

A "xifti" storing the result of applying FUN to the input(s). The data dimensions will be the same. The metadata of xifti will be retained, and the metadata of xifti2 will be discarded (if provided).

Details

If the "xifti" had the dlabel intent, and the transformation creates any value that is not a label value (e.g. a non-integer), then it is converted to a dscalar.

See Also

Other functions for manipulating `xifti` objects: add_surf(), apply_xifti(), combine_xifti(), convert_to_dlabel(), merge_xifti(), newdata_xifti(), remove_xifti(), select_xifti()