space-methods: Extract Geometric Properties of an Image

In bbuchsbaum/neuroim2: Data Structures for Brain Imaging Data

Extract Geometric Properties of an Image

Description

This function retrieves the geometric properties of a given image, such as dimensions and voxel size.

Retrieves the NeuroSpace object associated with an IndexLookupVol object.

Usage

space(x, ...)

## S4 method for signature 'IndexLookupVol'
space(x)

## S4 method for signature 'ROICoords'
space(x)

## S4 method for signature 'NeuroObj'
space(x)

## S4 method for signature 'NeuroSpace'
space(x)

Arguments

x	An IndexLookupVol object
...	Additional arguments, if needed.

Value

A NeuroSpace object representing the geometric space of x.

Examples

# Create a NeuroSpace object with dimensions (10, 10, 10) and voxel size (1, 1, 1)
x <- NeuroSpace(c(10, 10, 10), c(1, 1, 1))

# Create a NeuroVol object with random data and the specified NeuroSpace
vol <- NeuroVol(rnorm(10 * 10 * 10), x)

# Retrieve the geometric properties of the NeuroVol object
identical(x, space(vol))

space <- NeuroSpace(c(64, 64, 64), c(1, 1, 1), c(0, 0, 0))
ilv <- IndexLookupVol(space, c(1:100))
space(ilv)  # Get the associated NeuroSpace object

bbuchsbaum/neuroim2 documentation built on Feb. 26, 2025, 3:49 p.m.