neighborhood: Get Neighborhood of Voxels from an Image

Description Usage Arguments Value

View source: R/neighborhood.R

Description

This function wraps the getNeighborhoodInMask to be more friendly for R and nifti objects

Usage

1
2
neighborhood(img, mask = NULL, radius = rep(1, 3),
  get.gradient = TRUE, verbose = TRUE, run_gc = 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.

get.gradient

logical indicating if a matrix of gradients (at the center voxel) should be returned in addition to the value matrix

verbose

Print diagnostic messages

run_gc

Experimental - trying to run with gc(); for memory cleanup.

...

arguments other than spatial.info passed to getNeighborhoodInMask

Value

List similar to the output of getNeighborhoodInMask


neuroconductor-releases/extrantsr documentation built on Dec. 10, 2019, 12:07 a.m.