Arith-methods: Perform arithmetic operations between two SparseNeuroVol...

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

Perform arithmetic operations between two SparseNeuroVol objects

Description

This method performs arithmetic operations between two SparseNeuroVol objects (e1 and e2) using a generic arithmetic function. The dimensions of both objects are checked for compatibility before performing the operation.

This method performs arithmetic operations between two ROIVol objects (e1 and e2) using a generic arithmetic function. The dimensions of both objects are checked for compatibility before performing the operation.

Perform an arithmetic operation between two SparseNeuroVec objects. The input SparseNeuroVec objects must have the same dimensions and NeuroSpace objects. The method computes the union of the masks and performs the arithmetic operation on the non-zero values. The result is returned as a new SparseNeuroVec object.

Perform an arithmetic operation between a SparseNeuroVol object and a NeuroVol object. The input SparseNeuroVol and NeuroVol objects must have the same dimensions. The method performs the arithmetic operation on the non-zero values of the SparseNeuroVol and the corresponding values of the NeuroVol. The result is returned as a new DenseNeuroVol object.

Perform an arithmetic operation between two SparseNeuroVec objects. The input SparseNeuroVec objects must have the same dimensions. The method performs the arithmetic operation on the non-zero values of the SparseNeuroVec objects. The result is returned as a new SparseNeuroVec object.

Perform an arithmetic operation between two NeuroVec objects. The input NeuroVec objects must have the same dimensions. The method performs the arithmetic operation on the elements of the NeuroVec objects. The result is returned as a new DenseNeuroVec object.

Usage

## S4 method for signature 'SparseNeuroVol,SparseNeuroVol'
Arith(e1, e2)

## S4 method for signature 'DenseNeuroVol,DenseNeuroVol'
Arith(e1, e2)

## S4 method for signature 'DenseNeuroVec,DenseNeuroVec'
Arith(e1, e2)

## S4 method for signature 'SparseNeuroVol,NeuroVol'
Arith(e1, e2)

## S4 method for signature 'SparseNeuroVec,SparseNeuroVec'
Arith(e1, e2)

## S4 method for signature 'NeuroVec,NeuroVec'
Arith(e1, e2)

Arguments

e1	A NeuroVec object.
e2	A NeuroVec object.

Value

A SparseNeuroVol object containing the result of the arithmetic operation between e1 and e2.

An ROIVol object containing the result of the arithmetic operation between e1 and e2.

A SparseNeuroVec object representing the result of the arithmetic operation.

A DenseNeuroVol object representing the result of the arithmetic operation.

A SparseNeuroVec object representing the result of the arithmetic operation.

A DenseNeuroVec object representing the result of the arithmetic operation.

bbuchsbaum/neuroim2 documentation built on April 20, 2024, 4:20 p.m.