as_mmap

as_mmap-methods

as_mmap,MappedNeuroVec-method

as_mmap,FileBackedNeuroVec-method

as_mmap,NeuroVec-method

as_mmap,SparseNeuroVec-method

Generic for converting neuroimaging vectors to a memory-mapped
<code>MappedNeuroVec</code> on disk (when possible).
Methods for the <code>as_mmap</code> generic, which convert various
neuroimaging vector types to a <code>MappedNeuroVec</code> backed
by an on-disk NIfTI file.

A collection of data structures and methods for handling volumetric
brain imaging data, with a focus on functional magnetic resonance imaging (fMRI). Provides efficient
representations for three-dimensional and four-dimensional neuroimaging data through sparse and dense array
implementations, memory-mapped file access for large datasets, and
spatial transformation capabilities. Implements methods for image resampling,
spatial filtering, region of interest analysis, and connected component labeling. General introduction
to fMRI analysis can be found in Poldrack et al. (2024, "Handbook of functional MRI data analysis",
<ISBN:9781108795760>).

Bradley Buchsbaum

neuroim2

Data Structures for Brain Imaging Data

as_mmap function

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

Arguments

Convert a NeuroVec to a memory-mapped representation — as_mmap

<dl>

<dt>x</dt>
<dd>A neuroimaging vector (<code>NeuroVec</code>, <code>MappedNeuroVec</code>,
or <code>FileBackedNeuroVec</code>).</dd>


<dt>file</dt>
<dd>Optional output file name. If <code>NULL</code>, a temporary file
with extension <code>.nii</code> is created.</dd>


<dt>...</dt>
<dd>Additional arguments passed to methods (e.g. <code>data_type</code>,
<code>overwrite</code>).</dd>


<dt>data_type</dt>
<dd>Character string specifying the output data type for the
NIfTI file. Should be one of: "BINARY", "UBYTE", "SHORT", "INT", "FLOAT",
"DOUBLE". Default is "FLOAT".</dd>


<dt>overwrite</dt>
<dd>Logical; if <code>TRUE</code>, overwrite an existing file at the
specified path. Default is <code>FALSE</code>.</dd>

</dl>

as_mmap: Convert a NeuroVec to a memory-mapped representation

Description

Usage

Value

Arguments