Summary-methods: Summary Methods for Neuroimaging Objects

In neuroim2: Data Structures for Brain Imaging Data

Summary Methods for Neuroimaging Objects

Description

Methods for the Summary group generic (e.g., sum, min, max, range, prod, any, all) applied to neuroimaging data objects.

Usage

## S4 method for signature 'SparseNeuroVec'
Summary(x, ..., na.rm = FALSE)

## S4 method for signature 'SparseNeuroVol'
Summary(x, ..., na.rm = FALSE)

## S4 method for signature 'DenseNeuroVol'
Summary(x, ..., na.rm = FALSE)

## S4 method for signature 'DenseNeuroVol'
Summary(x, ..., na.rm = FALSE)

Arguments

x	A neuroimaging object (SparseNeuroVec, SparseNeuroVol, or DenseNeuroVol)
...	Additional arguments passed to methods
na.rm	Logical indicating whether to remove NA values before computation

Value

The result of the summary operation

Examples

# Create a simple volume
vol <- DenseNeuroVol(array(1:27, c(3,3,3)),
                     NeuroSpace(c(3L,3L,3L), c(1,1,1)))
sum(vol)
range(vol)

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