R: Image neighbourhoods

createNeighbourhoodInfo {tractor.base} | R Documentation

## Image neighbourhoods

### Description

This function calculates information about a cuboidal region of an image, with a centre and a fixed voxel width.

### Usage

    createNeighbourhoodInfo(width, dim = 3, centre = rep(0, dim))

### Arguments

`width` | An integer voxel width. Must be odd.
`dim` | An integer giving the dimensionality of the neighbourhood. Currently must be 3.
`centre` | A numeric vector giving the centre voxel of the neighbourhood. Must have exactly `dim` elements.

### Value

`createNeighbourhoodInfo` returns a list with class `"neighbourhoodInfo"` and elements

width

  Copied from the `width` argument.

dim

  Copied from the `dim` argument.

centre

  Copied from the `centre` argument.

vectors

  `dim` x `width^dim` matrix whose columns give the locations of each point in the neighbourhood.

innerProducts

  A square, symmetric matrix of inner products between every location in the neighbourhood and every other.

### Author(s)

Jon Clayden

### References

Please cite the following reference when using TractoR in your work:

J.D. Clayden, S. Muñoz Maniega, A.J. Storkey, M.D. King, M.E. Bastin & C.A. Clark (2011). TractoR: Magnetic resonance imaging and tractography with R. Journal of Statistical Software 44(8):1-18. http://www.jstatsoft.org/v44/i08/.

[Package tractor.base version 3.2.2 Index]