gridToIndex {neuroim}

Generic function to convert N-dimensional grid coordinate to 1D indices

Description

Generic function to convert N-dimensional grid coordinate to 1D indices

Usage

gridToIndex(x, coords)

## S4 method for signature 'BrainSlice,matrix'
gridToIndex(x, coords)

## S4 method for signature 'BrainSpace,matrix'
gridToIndex(x, coords)

## S4 method for signature 'BrainSpace,numeric'
gridToIndex(x, coords)

## S4 method for signature 'BrainVolume,matrix'
gridToIndex(x, coords)

## S4 method for signature 'BrainVolume,numeric'
gridToIndex(x, coords)

Arguments

x

the object, typically a BrainVolume or BrainSpace instance.

coords

a matrix where each row is a coordinate or a vector of length equal to ndim(x)

Value

a vector of indices