as_mmap: Convert a NeuroVec to a memory-mapped representation

In neuroim2: Data Structures for Brain Imaging Data

Convert a NeuroVec to a memory-mapped representation

Description

Generic for converting neuroimaging vectors to a memory-mapped MappedNeuroVec on disk (when possible).

Methods for the as_mmap generic, which convert various neuroimaging vector types to a MappedNeuroVec backed by an on-disk NIfTI file.

Usage

as_mmap(x, file = NULL, ...)

## S4 method for signature 'MappedNeuroVec'
as_mmap(x, file = NULL, ...)

## S4 method for signature 'FileBackedNeuroVec'
as_mmap(x, file = NULL, ...)

## S4 method for signature 'NeuroVec'
as_mmap(x, file = NULL, data_type = "FLOAT", overwrite = FALSE, ...)

## S4 method for signature 'SparseNeuroVec'
as_mmap(x, file = NULL, data_type = "FLOAT", overwrite = FALSE, ...)

Arguments

x	A neuroimaging vector (NeuroVec, MappedNeuroVec, or FileBackedNeuroVec).
file	Optional output file name. If NULL, a temporary file with extension .nii is created.
...	Additional arguments passed to methods (e.g. data_type, overwrite).
data_type	Character string specifying the output data type for the NIfTI file. Should be one of: "BINARY", "UBYTE", "SHORT", "INT", "FLOAT", "DOUBLE". Default is "FLOAT".
overwrite	Logical; if TRUE, overwrite an existing file at the specified path. Default is FALSE.

Value

A MappedNeuroVec (or x itself if already memory-mapped).

A MappedNeuroVec (or x itself if it is already memory-mapped).

neuroim2 documentation built on April 16, 2026, 5:07 p.m.