ch.systemsx.cisd.hdf5

Class HDF5DataBlock<T>

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5DataBlock<T>

public final class HDF5DataBlock<T>
extends java.lang.Object

A class that is used for iterating over a data set block by block, using natural data blocks. The Natural block for chunked data sets is a chunk, for non-chunked data sets it is the complete array.

The pattern for using this class is:

 for (HDF5DataBlock<int[]> block : reader.getIntNaturalBlocks(dsName1D))
 {
     float[] naturalBlock = block.getData();
     ... work on naturalBlock, use block.getIndex() and block.getOffset() where needed ...
 }
 

Note: If the size of the data set is not an integer number of blocks, then the last block will be smaller than the natural block size.

Method Summary

Methods

Modifier and Type	Method and Description
T	getData() Returns the data block itself.
long	getIndex() Returns the iteration index of this block, starting with 0.
long	getOffset() Returns the offset of this block in the data set.

Methods inherited from class java.lang.Object

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

Method Detail

getData

public T getData()

Returns the data block itself.

getOffset

public long getOffset()

Returns the offset of this block in the data set.

getIndex

public long getIndex()

Returns the iteration index of this block, starting with 0.