Skip to contents

load 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.