ch.systemsx.cisd.hdf5

Class HDF5ArrayBlockParams

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5ArrayBlockParams

public final class HDF5ArrayBlockParams
extends java.lang.Object

A parameter class to specify the block and slice to read from or write to a multi-dimensional array.

Method Summary

Modifier and Type	Method and Description
HDF5ArrayBlockParams	block(int... dimensions) Sets an array block dimensions.
HDF5ArrayBlockParams	index(long... blockIndex) Sets the array block indices.
HDF5ArrayBlockParams	offset(long... offset) Sets the array block offset.
HDF5ArrayBlockParams	slice(IndexMap boundIndices) Sets an array slice.
HDF5ArrayBlockParams	slice(long... boundIndices) Sets an array slice.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

block

public HDF5ArrayBlockParams block(int... dimensions)

Sets an array block dimensions.

Parameters:

dimensions - The block dimensions.

index

public HDF5ArrayBlockParams index(long... blockIndex)

Sets the array block indices.

Parameters:

blockIndex - The block index in each dimension (offset: multiply with the blockDimensions in the according dimension).

offset

public HDF5ArrayBlockParams offset(long... offset)

Sets the array block offset.

Parameters:

offset - The offset in the array to start reading from in each dimension.

slice

public HDF5ArrayBlockParams slice(long... boundIndices)

Sets an array slice. The slice is defined by "bound indices", each of which is fixed to a given value. The data block read or written only contains the free (i.e. non-fixed) indices.

Parameters:

boundIndices - The array containing the values of the bound indices at the respective index positions, and -1 at the free index positions. For example an array of new long[] { -1, -1, 5, -1, 7, -1 } has 2 and 4 as bound indices and binds them to the values 5 and 7, respectively.

slice

public HDF5ArrayBlockParams slice(IndexMap boundIndices)

Sets an array slice. The slice is defined by "bound indices", each of which is fixed to a given value. The data block read or written only contains the free (i.e. non-fixed) indices.

Parameters:

boundIndices - The mapping of indices to index values which should be bound. For example a map of new IndexMap().mapTo(2, 5).mapTo(4, 7) has 2 and 4 as bound indices and binds them to the values 5 and 7, respectively.