summary-neuro-methods: Summary of Neuroimaging Objects

In neuroim2: Data Structures for Brain Imaging Data

Summary of Neuroimaging Objects

Description

Provides a concise summary of neuroimaging volume and vector objects, including spatial metadata and data statistics.

Usage

## S4 method for signature 'NeuroVol'
summary(object, ...)

## S4 method for signature 'DenseNeuroVec'
summary(object, ...)

## S4 method for signature 'SparseNeuroVec'
summary(object, ...)

Arguments

object	A neuroimaging object.
...	Additional arguments (currently ignored).

Value

An object of class "summary.NeuroVol" or "summary.NeuroVec" (invisibly), with a print method.

Examples

vol <- DenseNeuroVol(array(rnorm(27), c(3,3,3)),
                     NeuroSpace(c(3L,3L,3L), c(1,1,1)))
summary(vol)

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