ch.systemsx.cisd.hdf5

Class HDF5ArrayBlockParamsBuilder

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5ArrayBlockParamsBuilder

public class HDF5ArrayBlockParamsBuilder
extends java.lang.Object

A builder class for HDF5ArrayBlockParams.

Method Summary

Modifier and Type	Method and Description
static HDF5ArrayBlockParams	array() Creates a parameter that reads the complete array.
static HDF5ArrayBlockParams	block(int... dimensions) Creates a parameter that reads an array block.
static HDF5ArrayBlockParams	blockIndex(long... blockIndex) Creates a parameter that writes a block with given blockIndex.
static HDF5ArrayBlockParams	blockOffset(long... blockOffset) Creates a parameter that writes a block with given blockOffset.
static HDF5ArrayBlockParams	slice(IndexMap boundIndices) Creates a parameter that reads or writes an array slice.
static HDF5ArrayBlockParams	slice(long... boundIndices) Creates a parameter that reads an array slice.

Methods inherited from class java.lang.Object

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

Method Detail

array

public static HDF5ArrayBlockParams array()

Creates a parameter that reads the complete array.

block

public static HDF5ArrayBlockParams block(int... dimensions)

Creates a parameter that reads an array block.

Parameters:

dimensions - The block dimensions.

slice

public static HDF5ArrayBlockParams slice(long... boundIndices)

Creates a parameter that reads 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 static HDF5ArrayBlockParams slice(IndexMap boundIndices)

Creates a parameter that reads or writes 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.

blockIndex

public static HDF5ArrayBlockParams blockIndex(long... blockIndex)

Creates a parameter that writes a block with given blockIndex.

Parameters:

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

blockOffset

public static HDF5ArrayBlockParams blockOffset(long... blockOffset)

Creates a parameter that writes a block with given blockOffset.

Parameters:

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