scaled_neighborhood: Get Scaled Neighborhood of Voxels from an Image

Description Usage Arguments Value

View source: R/scaled_neighborhood.R

Description

This function wraps the neighborhood to provided scaled neighborhood or its ranks

Usage

1
2
3
4
5
6
7
8
9
scaled_neighborhood(
  img,
  mask = NULL,
  radius = rep(1, 3),
  method = c("pearson", "spearman"),
  center = TRUE,
  scale = TRUE,
  verbose = TRUE
)

Arguments

img

Object of class nifti, character or antsImage

mask

Binary image of class nifti, antsImage, character. Only neighborhoods inside the mask will be taken

radius

vector of length 3 for number of voxels to go in each direction. Default is 27 neighbors (including voxel at center). Passed to getNeighborhoodInMask.

method

If pearson, scaling done on original data. If spearman, the ranks.

center

Should the data be centered

scale

Should the data be scaled

verbose

print diagnostic messages

Value

List similar to the output of getNeighborhoodInMask


muschellij2/extrantsr documentation built on July 27, 2021, 7:41 a.m.