NeighbourhoodInfo: Class representing a cuboidal neighbourhood in an image
Description
This class represents a cuboidal region of an image, with a centre and a fixed voxel width.Usage
createNeighbourhoodInfo(width, dim = 3, centre = rep(0, dim))
isNeighbourhoodInfo(object)
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 c("info.neighbourhood", "list") and elements- widthCopied from the
width argument. - dimCopied from the
dim argument. - centreCopied from the
centre argument. - vectors
dim x width^dim matrix whose columns give the locations of each point in the neighbourhood. - innerProductsA square, symmetric matrix of inner products between every location in the neighbourhood and every other.
isNeighbourhoodInfo returns TRUE if object is a NeighbourhoodInfo object, and FALSE otherwise.