MappedNeuroVec-class: MappedNeuroVec

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

MappedNeuroVec

Description

A class representing a four-dimensional brain image, backed by a memory-mapped file. MappedNeuroVec objects store their data in a memory-mapped file, providing efficient access to large brain images without loading the entire dataset into memory. This class inherits from the NeuroVec and implements the ArrayLike4D interface.

constructs a MappedNeuroVec object

Usage

MappedNeuroVec(file_name)

Arguments

file_name

the name of the 4D image file that containing the memory-mapped data source.

Value

a new instance of type MappedNeuroVec

Slots

filemap

An instance of the mmap class representing the memory-mapped file containing the brain image data.

offset

An integer representing the offset (in bytes) within the memory-mapped file where the brain image data starts.

bbuchsbaum/neuroim2 documentation built on March 29, 2024, 6:36 p.m.