Logic-methods: Logic Operations for Neuroimaging Volumes

In neuroim2: Data Structures for Brain Imaging Data

Logic Operations for Neuroimaging Volumes

Description

Methods for performing logical operations (& and |) on neuroimaging volume objects. Results are always returned as LogicalNeuroVol objects that preserve spatial metadata.

Usage

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

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

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

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

## S4 method for signature 'NeuroVol,logical'
Logic(e1, e2)

## S4 method for signature 'logical,NeuroVol'
Logic(e1, e2)

Arguments

e1, e2

Neuroimaging volume objects or logical values.

Value

A LogicalNeuroVol.

Examples

sp <- NeuroSpace(c(5L, 5L, 5L), c(1, 1, 1))
v1 <- DenseNeuroVol(array(sample(0:1, 125, replace = TRUE), c(5, 5, 5)), sp)
v2 <- DenseNeuroVol(array(sample(0:1, 125, replace = TRUE), c(5, 5, 5)), sp)
intersection <- v1 & v2
union_mask  <- v1 | v2

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