as.matrix-methods: convert a 'NeuroVec' to a matrix

as.matrix,ClusteredNeuroVec-methodR Documentation

convert a NeuroVec to a matrix

Description

Converts a NeuroVecSeq to a dense voxel-by-time matrix.

Usage

## S4 method for signature 'ClusteredNeuroVec'
as.matrix(x, by = c("cluster", "voxel"))

## S4 method for signature 'MappedNeuroVec'
as.matrix(x)

## S4 method for signature 'NeuroVec'
as.matrix(x)

## S4 method for signature 'DenseNeuroVec'
as.matrix(x)

## S4 method for signature 'NeuroVecSeq'
as.matrix(x, ...)

## S4 method for signature 'ROIVec'
as.matrix(x)

## S4 method for signature 'AbstractSparseNeuroVec'
as.matrix(x, ...)

Arguments

x

The object to convert to a matrix

by

For ClusteredNeuroVec: controls the conversion target. Defaults to "cluster" to return a TxK matrix of cluster time-series. "voxel" is reserved for future use.

...

Additional arguments

Value

A matrix with one row per voxel and one column per time point.

A matrix representation of the object


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