coords-methods: Extract coordinates from an IndexLookupVol object

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

Extract coordinates from an IndexLookupVol object

Description

This method extracts the coordinates from an IndexLookupVol object based on a given index.

Usage

## S4 method for signature 'IndexLookupVol'
coords(x, i)

## S4 method for signature 'ROICoords'
coords(x, real = FALSE)

## S4 method for signature 'AbstractSparseNeuroVec'
coords(x, i)

Arguments

x	An IndexLookupVol object to extract coordinates from.
i	The index into the lookup volume.
real	if TRUE, return coordinates in real world units

Value

The extracted coordinates corresponding to the provided index. If the index is not found, it returns NA.

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