BrainSpace {neuroim}

Constructor function for BrainSpace class

Description

Constructor function for BrainSpace class

Usage

BrainSpace(Dim, spacing = NULL, origin = NULL, axes = NULL,
  trans = NULL)

Arguments

Dim

a vector describing the dimensions of the spatial grid

spacing

the real-valued voxel dimensions (usually in millimeters)

origin

the coordinate origin of the image space

axes

the image axes ordering (default is based on the NIFTI standard, Left-Posterior-Inferior)

trans

a matrix representing the coordinate transformation associated with the image space (default is based on the NIFTI standard, Left-Posterior-Inferior)

Value

an instance of class BrainSpace

Note

one should rarely need to create a new BrainSpace instance, as it will almost always be created automatically using information stored in an image header. Also, If one already has an existing image object, its BrainSpace instance can be easily extracted with the space method.

Examples

bspace <- BrainSpace(c(64,64,64), origin=c(0,0,0), spacing=c(2,2,2))
print(bspace)
origin(bspace)
axes(bspace)
trans(bspace)