indexBox: Get indices of adjacent entries in array

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/indexBox.R

Description

Determines the relative vector positions of entries which are adjacent in an array.

Usage

1
indexBox(upp, lwr, dim)

Arguments

upp

A vector of non-negative integers, giving the distance in the positive direction from the centre in each co-ordinate.

lwr

A vector of non-positive integers, giving the negative distance from the centre.

dim

integer vector of array dimensions.

Details

Given a particular cell in an array, which are the entries within (for example) 1 unit in any direction? This function gives the (relative) value of such indices. See examples.

Indices may be repeated if the range exceeds the size of the array in any dimension.

Value

An integer vector giving relative positions of the indices.

Author(s)

Robin Evans

See Also

arrayInd.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
arr = array(1:144, dim=c(3,4,3,4))
arr[2,2,2,3]
# which are entries within 1 unit each each direction of 2,2,2,3?

inds = 89 + indexBox(1,-1,c(3,4,3,4))
inds = inds[inds > 0 & inds <= 144]
arrayInd(inds, c(3,4,3,4))

# what about just in second dimension?
inds = 89 + indexBox(c(0,1,0,0),c(0,-1,0,0),c(3,4,3,4))
inds = inds[inds > 0 & inds <= 144]
arrayInd(inds, c(3,4,3,4))

rje42/rje documentation built on Aug. 15, 2017, 7:43 a.m.