public interface IHDF5LongReader
long values from HDF5 files.
Note: This interface supports block access and sliced access (which is a special cases of block access) to arrays. The performance of this block access can vary greatly depending on how the data are layed out in the HDF5 file. For best performance, the block (or slice) dimension should be chosen to be equal to the chunk dimensions of the array, as in this case the block written / read are stored as consecutive value in the HDF5 file and one write / read access will suffice.
Note: If the values read are unsigned, use the methods in UnsignedIntUtils to convert
to a larger Java integer type that can hold all values as unsigned.
| Modifier and Type | Method and Description |
|---|---|
long[] |
getArrayAttr(java.lang.String objectPath,
java.lang.String attributeName)
Reads a
long[] attribute named attributeName from the data set
objectPath. |
java.lang.Iterable<HDF5DataBlock<long[]>> |
getArrayNaturalBlocks(java.lang.String dataSetPath)
Provides all natural blocks of this one-dimensional data set to iterate over.
|
long |
getAttr(java.lang.String objectPath,
java.lang.String attributeName)
Reads a
long attribute named attributeName from the data set
objectPath. |
long[][] |
getMatrixAttr(java.lang.String objectPath,
java.lang.String attributeName)
Reads a
long matrix attribute named attributeName
from the data set objectPath. |
MDLongArray |
getMDArrayAttr(java.lang.String objectPath,
java.lang.String attributeName)
Reads a multi-dimensional array
long attribute named attributeName
from the data set objectPath. |
java.lang.Iterable<HDF5MDDataBlock<MDLongArray>> |
getMDArrayNaturalBlocks(java.lang.String dataSetPath)
Provides all natural blocks of this multi-dimensional data set to iterate over.
|
long |
read(java.lang.String objectPath)
Reads a
long value from the data set objectPath. |
long[] |
readArray(java.lang.String objectPath)
Reads a
long array (of rank 1) from the data set objectPath. |
long[] |
readArrayBlock(java.lang.String objectPath,
int blockSize,
long blockNumber)
Reads a block from a
long array (of rank 1) from the data set
objectPath. |
long[] |
readArrayBlockWithOffset(java.lang.String objectPath,
int blockSize,
long offset)
Reads a block from
long array (of rank 1) from the data set
objectPath. |
long[][] |
readMatrix(java.lang.String objectPath)
Reads a
long matrix (array of arrays) from the data set
objectPath. |
long[][] |
readMatrixBlock(java.lang.String objectPath,
int blockSizeX,
int blockSizeY,
long blockNumberX,
long blockNumberY)
Reads a
long matrix (array of arrays) from the data set
objectPath. |
long[][] |
readMatrixBlockWithOffset(java.lang.String objectPath,
int blockSizeX,
int blockSizeY,
long offsetX,
long offsetY)
Reads a
long matrix (array of arrays) from the data set
objectPath. |
MDLongArray |
readMDArray(java.lang.String objectPath)
Reads a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readMDArrayBlock(java.lang.String objectPath,
int[] blockDimensions,
long[] blockNumber)
Reads a block from a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readMDArrayBlockWithOffset(java.lang.String objectPath,
int[] blockDimensions,
long[] offset)
Reads a block from a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readMDArraySlice(java.lang.String objectPath,
IndexMap boundIndices)
Reads a slice of a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readMDArraySlice(java.lang.String objectPath,
long[] boundIndices)
Reads a slice of a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readSlicedMDArrayBlock(java.lang.String objectPath,
int[] blockDimensions,
long[] blockNumber,
IndexMap boundIndices)
Reads a sliced block from a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readSlicedMDArrayBlock(java.lang.String objectPath,
int[] blockDimensions,
long[] blockNumber,
long[] boundIndices)
Reads a sliced block from a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readSlicedMDArrayBlockWithOffset(java.lang.String objectPath,
int[] blockDimensions,
long[] offset,
IndexMap boundIndices)
Reads a sliced block of a multi-dimensional
long array from the data set
objectPath. |
MDLongArray |
readSlicedMDArrayBlockWithOffset(java.lang.String objectPath,
int[] blockDimensions,
long[] offset,
long[] boundIndices)
Reads a sliced block of a multi-dimensional
long array from the data set
objectPath. |
int[] |
readToMDArrayBlockWithOffset(java.lang.String objectPath,
MDLongArray array,
int[] blockDimensions,
long[] offset,
int[] memoryOffset)
Reads a block of the multi-dimensional
long array data set
objectPath into a given array in memory. |
int[] |
readToMDArrayWithOffset(java.lang.String objectPath,
MDLongArray array,
int[] memoryOffset)
Reads a multi-dimensional
long array data set objectPath
into a given array in memory. |
long getAttr(java.lang.String objectPath,
java.lang.String attributeName)
long attribute named attributeName from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.attributeName - The name of the attribute to read.long[] getArrayAttr(java.lang.String objectPath,
java.lang.String attributeName)
long[] attribute named attributeName from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.attributeName - The name of the attribute to read.MDLongArray getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName)
long attribute named attributeName
from the data set objectPath.objectPath - The name (including path information) of the data set object in the file.attributeName - The name of the attribute to read.long[][] getMatrixAttr(java.lang.String objectPath,
java.lang.String attributeName)
throws HDF5JavaException
long matrix attribute named attributeName
from the data set objectPath.objectPath - The name (including path information) of the data set object in the file.attributeName - The name of the attribute to read.HDF5JavaExceptionlong read(java.lang.String objectPath)
long value from the data set objectPath. This method
doesn't check the data space but simply reads the first value.objectPath - The name (including path information) of the data set object in the file.long[] readArray(java.lang.String objectPath)
long array (of rank 1) from the data set objectPath.objectPath - The name (including path information) of the data set object in the file.int[] readToMDArrayWithOffset(java.lang.String objectPath,
MDLongArray array,
int[] memoryOffset)
long array data set objectPath
into a given array in memory.objectPath - The name (including path information) of the data set object in the file.array - The array to read the data into.memoryOffset - The offset in the array to write the data to.int[] readToMDArrayBlockWithOffset(java.lang.String objectPath,
MDLongArray array,
int[] blockDimensions,
long[] offset,
int[] memoryOffset)
long array data set
objectPath into a given array in memory.objectPath - The name (including path information) of the data set object in the file.array - The array to read the data into.blockDimensions - The size of the block to read along each axis.offset - The offset of the block in the data set.memoryOffset - The offset of the block in the array to write the data to.long[] readArrayBlock(java.lang.String objectPath,
int blockSize,
long blockNumber)
long array (of rank 1) from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.blockSize - The block size (this will be the length of the long[] returned
if the data set is long enough).blockNumber - The number of the block to read (starting with 0, offset: multiply with
blockSize).long[] readArrayBlockWithOffset(java.lang.String objectPath,
int blockSize,
long offset)
long array (of rank 1) from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.blockSize - The block size (this will be the length of the long[]
returned).offset - The offset of the block in the data set to start reading from (starting with 0).long[][] readMatrix(java.lang.String objectPath)
throws HDF5JavaException
long matrix (array of arrays) from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.HDF5JavaException - If the data set objectPath is not of rank 2.long[][] readMatrixBlock(java.lang.String objectPath,
int blockSizeX,
int blockSizeY,
long blockNumberX,
long blockNumberY)
throws HDF5JavaException
long matrix (array of arrays) from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.blockSizeX - The size of the block in the x dimension.blockSizeY - The size of the block in the y dimension.blockNumberX - The block number in the x dimension (offset: multiply with
blockSizeX).blockNumberY - The block number in the y dimension (offset: multiply with
blockSizeY).HDF5JavaException - If the data set objectPath is not of rank 2.long[][] readMatrixBlockWithOffset(java.lang.String objectPath,
int blockSizeX,
int blockSizeY,
long offsetX,
long offsetY)
throws HDF5JavaException
long matrix (array of arrays) from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.blockSizeX - The size of the block in the x dimension.blockSizeY - The size of the block in the y dimension.offsetX - The offset in x dimension in the data set to start reading from.offsetY - The offset in y dimension in the data set to start reading from.HDF5JavaException - If the data set objectPath is not of rank 2.MDLongArray readMDArray(java.lang.String objectPath)
long array from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.MDLongArray readMDArraySlice(java.lang.String objectPath, IndexMap boundIndices)
long array from the data set
objectPath. The slice is defined by "bound indices", each of which is fixed to a
given value. The returned data block only contains the free (i.e. non-fixed) indices.objectPath - The name (including path information) of the data set object in the file.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.MDLongArray readMDArraySlice(java.lang.String objectPath, long[] boundIndices)
long array from the data set
objectPath. The slice is defined by "bound indices", each of which is fixed to a
given value. The returned data block only contains the free (i.e. non-fixed) indices.objectPath - The name (including path information) of the data set object in the file.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.MDLongArray readMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber)
long array from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.blockDimensions - The extent of the block in each dimension.blockNumber - The block number in each dimension (offset: multiply with the
blockDimensions in the according dimension).MDLongArray readSlicedMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber, IndexMap boundIndices)
long array from the data set
objectPath. The slice is defined by "bound indices", each of which is fixed to a
given value. The returned data block only contains the free (i.e. non-fixed) indices.objectPath - The name (including path information) of the data set object in the file.blockDimensions - The extent of the block in each dimension.blockNumber - The block number in each dimension (offset: multiply with the
blockDimensions in the according dimension).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.MDLongArray readSlicedMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber, long[] boundIndices)
long array from the data set
objectPath. The slice is defined by "bound indices", each of which is fixed to a
given value. The returned data block only contains the free (i.e. non-fixed) indices.objectPath - The name (including path information) of the data set object in the file.blockDimensions - The extent of the block in each dimension.blockNumber - The block number in each dimension (offset: multiply with the
blockDimensions in the according dimension).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.MDLongArray readMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset)
long array from the data set
objectPath.objectPath - The name (including path information) of the data set object in the file.blockDimensions - The extent of the block in each dimension.offset - The offset in the data set to start reading from in each dimension.MDLongArray readSlicedMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset, IndexMap boundIndices)
long array from the data set
objectPath. The slice is defined by "bound indices", each of which is fixed to a
given value. The returned data block only contains the free (i.e. non-fixed) indices.objectPath - The name (including path information) of the data set object in the file.blockDimensions - The extent of the block in each dimension.offset - The offset in the data set to start reading from in each dimension.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.MDLongArray readSlicedMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset, long[] boundIndices)
long array from the data set
objectPath. The slice is defined by "bound indices", each of which is fixed to a
given value. The returned data block only contains the free (i.e. non-fixed) indices.objectPath - The name (including path information) of the data set object in the file.blockDimensions - The extent of the block in each dimension.offset - The offset in the data set to start reading from in each dimension.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.java.lang.Iterable<HDF5DataBlock<long[]>> getArrayNaturalBlocks(java.lang.String dataSetPath) throws HDF5JavaException
HDF5JavaException - If the data set is not of rank 1.HDF5DataBlockjava.lang.Iterable<HDF5MDDataBlock<MDLongArray>> getMDArrayNaturalBlocks(java.lang.String dataSetPath)
HDF5MDDataBlock