org.janelia.saalfeldlab.n5.util

Interface SubArrayCopy

public interface SubArrayCopy

Copy sub-region between flattened arrays (of different sizes).

The SubArrayCopy.copy method requires the nD size of the flattened source and target arrays, the nD starting position and nD size of the source region to copy, and the nD starting position in the target to copy to.

Method Summary

Modifier and Type	Method and Description
static void	copy(Object src, int[] srcSize, int[] srcPos, Object dest, int[] destSize, int[] destPos, int[] size) Copy a nD region from src to dest, where src and dest are flattened nD array of dimensions srcSize and destSize, respectively.
static <T> void	copyNDRangeRecursive(int d, T src, int[] srcStrides, int srcPos, T dest, int[] destStrides, int destPos, int[] size) Recursively copy a (d+1) dimensional region from src to dest, where src and dest are flattened nD array with strides srcStrides and destStrides, respectively.
static int[]	createAllocationSteps(int[] dimensions)
static void	createAllocationSteps(int[] dimensions, int[] steps) Create allocation step array from the dimensions of an N-dimensional array.
static int	positionToIndex(int[] position, int[] dimensions)

Method Detail

copy

static void copy(Object src,
                 int[] srcSize,
                 int[] srcPos,
                 Object dest,
                 int[] destSize,
                 int[] destPos,
                 int[] size)

Copy a nD region from src to dest, where src and dest are flattened nD array of dimensions srcSize and destSize, respectively.

Parameters:

src - flattened nD source array

srcSize - dimensions of src

srcPos - starting position, in src, of the range to copy

dest - flattened nD destination array

destSize - dimensions of dest

destPos - starting position, in dest, of the range to copy

size - size of the range to copy

positionToIndex

static int positionToIndex(int[] position,
                           int[] dimensions)

createAllocationSteps

static void createAllocationSteps(int[] dimensions,
                                  int[] steps)

Create allocation step array from the dimensions of an N-dimensional array.

Parameters:

dimensions -

steps -

createAllocationSteps

static int[] createAllocationSteps(int[] dimensions)

copyNDRangeRecursive

static <T> void copyNDRangeRecursive(int d,
                                     T src,
                                     int[] srcStrides,
                                     int srcPos,
                                     T dest,
                                     int[] destStrides,
                                     int destPos,
                                     int[] size)

Recursively copy a (d+1) dimensional region from src to dest, where src and dest are flattened nD array with strides srcStrides and destStrides, respectively.

For d=0, a 1D line of length size[0] is copied (equivalent to System.arraycopy). For d=1, a 2D plane of size size[0] * size[1] is copied, by recursively copying 1D lines, starting srcStrides[1] (respectively destStrides[1]) apart. For d=2, a 3D box is copied by recursively copying 2D planes, etc.

Parameters:

d - current dimension

src - flattened nD source array

srcStrides - nD strides of src

srcPos - flattened index (in src) to start copying from

dest - flattened nD destination array

destStrides - nD strides of dest

destPos - flattened index (in dest) to start copying to

size - nD size of the range to copy