read_vec: read_vec

In bbuchsbaum/neuroim2: Data Structures and IO for Neuroimaging Data with an Emphasis on Functional Magnetic Resonance Imaging (FMRI)

read_vec

Description

This function loads an image volume from a file.

Usage

read_vec(
  file_name,
  indices = NULL,
  mask = NULL,
  mode = c("normal", "mmap", "bigvec", "filebacked")
)

Arguments

file_name	The name(s) of the file(s) to load. If more than one file_name is specified, the files are loaded and concatenated.
indices	The indices of the sub-volumes to load (e.g. if the file is 4-dimensional).
mask	A mask defining the spatial elements to load.
mode	The IO mode which is one of "normal", "mmap", "bigvec", or "filebacked".

Value

An NeuroVec object.

Note

Memory-mapping a gzipped file is not currently allowed.

bbuchsbaum/neuroim2 documentation built on Nov. 3, 2024, 9:31 a.m.