neuro_space: Constructor function for 'NeuroSpace' class

Description Usage Arguments Value Note Examples

Description

Constructor function for NeuroSpace class

Usage

1
2

Arguments

dim

a vector describing the dimensions of the image grid

spacing

the real-valued voxel dimensions (e.g. 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, "Neurological" orientation)

Value

an instance of class NeuroSpace

Note

one should rarely need to create a new NeuroSpace 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 NeuroSpace instance can be easily extracted with the space method.

Examples

1
2
3
4
5
bspace <- NeuroSpace(c(64,64,64), origin=c(0,0,0), spacing=c(2,2,2))
print(bspace)
origin(bspace)
axes(bspace)
trans(bspace)

bbuchsbaum/neuroim2 documentation built on Dec. 3, 2019, 12:12 p.m.