ch.systemsx.cisd.hdf5

Interface IHDF5ShortWriter

All Superinterfaces:

IHDF5ShortReader, IHDF5UnsignedShortWriter

public interface IHDF5ShortWriter
extends IHDF5UnsignedShortWriter

An interface that provides methods for writing short values to 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 you need to convert from and to unsigned values, use the methods of UnsignedIntUtils.

Method Summary

Methods

Modifier and Type	Method and Description
void	createArray(java.lang.String objectPath, int size) Creates a short array (of rank 1).
void	createArray(java.lang.String objectPath, int size, HDF5IntStorageFeatures features) Creates a short array (of rank 1).
void	createArray(java.lang.String objectPath, long size, int blockSize) Creates a short array (of rank 1).
void	createArray(java.lang.String objectPath, long size, int blockSize, HDF5IntStorageFeatures features) Creates a short array (of rank 1).
void	createMatrix(java.lang.String objectPath, int sizeX, int sizeY) Creates a short matrix (array of rank 2).
void	createMatrix(java.lang.String objectPath, int sizeX, int sizeY, HDF5IntStorageFeatures features) Creates a short matrix (array of rank 2).
void	createMatrix(java.lang.String objectPath, long sizeX, long sizeY, int blockSizeX, int blockSizeY) Creates a short matrix (array of rank 2).
void	createMatrix(java.lang.String objectPath, long sizeX, long sizeY, int blockSizeX, int blockSizeY, HDF5IntStorageFeatures features) Creates a short matrix (array of rank 2).
void	createMDArray(java.lang.String objectPath, int[] dimensions) Creates a multi-dimensional short array.
void	createMDArray(java.lang.String objectPath, int[] dimensions, HDF5IntStorageFeatures features) Creates a multi-dimensional short array.
void	createMDArray(java.lang.String objectPath, long[] dimensions, int[] blockDimensions) Creates a multi-dimensional short array.
void	createMDArray(java.lang.String objectPath, long[] dimensions, int[] blockDimensions, HDF5IntStorageFeatures features) Creates a multi-dimensional short array.
void	setArrayAttr(java.lang.String objectPath, java.lang.String name, short[] value) Set a short[] attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, short value) Set a short attribute on the referenced object.
void	setMatrixAttr(java.lang.String objectPath, java.lang.String name, short[][] value) Set a short[][] attribute on the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String name, MDShortArray value) Set a multi-dimensional code>short attribute on the referenced object.
void	write(java.lang.String objectPath, short value) Writes out a short value.
void	writeArray(java.lang.String objectPath, short[] data) Writes out a short array (of rank 1).
void	writeArray(java.lang.String objectPath, short[] data, HDF5IntStorageFeatures features) Writes out a short array (of rank 1).
void	writeArrayBlock(java.lang.String objectPath, short[] data, long blockNumber) Writes out a block of a short array (of rank 1).
void	writeArrayBlockWithOffset(java.lang.String objectPath, short[] data, int dataSize, long offset) Writes out a block of a short array (of rank 1).
void	writeMatrix(java.lang.String objectPath, short[][] data) Writes out a short matrix (array of rank 2).
void	writeMatrix(java.lang.String objectPath, short[][] data, HDF5IntStorageFeatures features) Writes out a short matrix (array of rank 2).
void	writeMatrixBlock(java.lang.String objectPath, short[][] data, long blockNumberX, long blockNumberY) Writes out a block of a short matrix (array of rank 2).
void	writeMatrixBlockWithOffset(java.lang.String objectPath, short[][] data, int dataSizeX, int dataSizeY, long offsetX, long offsetY) Writes out a block of a short matrix (array of rank 2).
void	writeMatrixBlockWithOffset(java.lang.String objectPath, short[][] data, long offsetX, long offsetY) Writes out a block of a short matrix (array of rank 2).
void	writeMDArray(java.lang.String objectPath, MDShortArray data) Writes out a multi-dimensional short array.
void	writeMDArray(java.lang.String objectPath, MDShortArray data, HDF5IntStorageFeatures features) Writes out a multi-dimensional short array.
void	writeMDArrayBlock(java.lang.String objectPath, MDShortArray data, long[] blockNumber) Writes out a block of a multi-dimensional short array.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, MDShortArray data, int[] blockDimensions, long[] offset, int[] memoryOffset) Writes out a block of a multi-dimensional short array.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, MDShortArray data, long[] offset) Writes out a block of a multi-dimensional short array.
void	writeMDArraySlice(java.lang.String objectPath, MDShortArray data, IndexMap boundIndices) Writes out a slice of a multi-dimensional short array.
void	writeMDArraySlice(java.lang.String objectPath, MDShortArray data, long[] boundIndices) Writes out a slice of a multi-dimensional short array.
void	writeSlicedMDArrayBlock(java.lang.String objectPath, MDShortArray data, long[] blockNumber, IndexMap boundIndices) Writes out a sliced block of a multi-dimensional short array.
void	writeSlicedMDArrayBlock(java.lang.String objectPath, MDShortArray data, long[] blockNumber, long[] boundIndices) Writes out a sliced block of a multi-dimensional short array.
void	writeSlicedMDArrayBlockWithOffset(java.lang.String objectPath, MDShortArray data, long[] offset, IndexMap boundIndices) Writes out a sliced block of a multi-dimensional short array.
void	writeSlicedMDArrayBlockWithOffset(java.lang.String objectPath, MDShortArray data, long[] offset, long[] boundIndices) Writes out a sliced block of a multi-dimensional short array.

Methods inherited from interface ch.systemsx.cisd.hdf5.IHDF5ShortReader

getArrayAttr, getArrayNaturalBlocks, getAttr, getMatrixAttr, getMDArrayAttr, getMDArrayNaturalBlocks, read, readArray, readArrayBlock, readArrayBlockWithOffset, readMatrix, readMatrixBlock, readMatrixBlockWithOffset, readMDArray, readMDArrayBlock, readMDArrayBlockWithOffset, readMDArraySlice, readMDArraySlice, readSlicedMDArrayBlock, readSlicedMDArrayBlock, readSlicedMDArrayBlockWithOffset, readSlicedMDArrayBlockWithOffset, readToMDArrayBlockWithOffset, readToMDArrayWithOffset

Method Detail

setAttr

void setAttr(java.lang.String objectPath,
           java.lang.String name,
           short value)

Set a short attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Specified by:

setAttr in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

setArrayAttr

void setArrayAttr(java.lang.String objectPath,
                java.lang.String name,
                short[] value)

Set a short[] attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Specified by:

setArrayAttr in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

setMDArrayAttr

void setMDArrayAttr(java.lang.String objectPath,
                  java.lang.String name,
                  MDShortArray value)

Set a multi-dimensional code>short attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Specified by:

setMDArrayAttr in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

setMatrixAttr

void setMatrixAttr(java.lang.String objectPath,
                 java.lang.String name,
                 short[][] value)

Set a short[][] attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Specified by:

setMatrixAttr in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

write

void write(java.lang.String objectPath,
         short value)

Writes out a short value.

Specified by:

write in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

value - The value to write.

writeArray

void writeArray(java.lang.String objectPath,
              short[] data)

Writes out a short array (of rank 1).

Specified by:

writeArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

writeArray

void writeArray(java.lang.String objectPath,
              short[] data,
              HDF5IntStorageFeatures features)

Writes out a short array (of rank 1).

Specified by:

writeArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

features - The storage features of the data set.

createArray

void createArray(java.lang.String objectPath,
               int size)

Creates a short array (of rank 1).

Specified by:

createArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

size - When the writer is configured to use extendable data types (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial size and the chunk size of the array will be size. When the writer is configured to enforce a non-extendable data set, the initial size equals the total size and will be size.

createArray

void createArray(java.lang.String objectPath,
               long size,
               int blockSize)

Creates a short array (of rank 1).

Specified by:

createArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

size - The size of the short array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

blockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()).

createArray

void createArray(java.lang.String objectPath,
               int size,
               HDF5IntStorageFeatures features)

Creates a short array (of rank 1).

Specified by:

createArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

size - The size of the short array to create. When requesting a chunked data set (e.g. HDF5IntStorageFeatures.INT_CHUNKED), the initial size of the array will be 0 and the chunk size will be arraySize. When allowing a chunked data set (e.g. HDF5IntStorageFeatures.INT_NO_COMPRESSION when the writer is not configured to avoid extendable data types, see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial size and the chunk size of the array will be arraySize. When enforcing a on-extendable data set (e.g. HDF5IntStorageFeatures.INT_CONTIGUOUS), the initial size equals the total size and will be arraySize.

features - The storage features of the data set.

createArray

void createArray(java.lang.String objectPath,
               long size,
               int blockSize,
               HDF5IntStorageFeatures features)

Creates a short array (of rank 1).

Specified by:

createArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

size - The size of the short array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

blockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and features is HDF5IntStorageFeature.INT_NO_COMPRESSION.

features - The storage features of the data set.

writeArrayBlock

void writeArrayBlock(java.lang.String objectPath,
                   short[] data,
                   long blockNumber)

Writes out a block of a short array (of rank 1). The data set needs to have been created by createArray(String, long, int, HDF5IntStorageFeatures) beforehand.

Specified by:

writeArrayBlock in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. The length defines the block size. Must not be null or of length 0.

blockNumber - The number of the block to write.

writeArrayBlockWithOffset

void writeArrayBlockWithOffset(java.lang.String objectPath,
                             short[] data,
                             int dataSize,
                             long offset)

Writes out a block of a short array (of rank 1). The data set needs to have been created by createArray(String, long, int, HDF5IntStorageFeatures) beforehand.

Use this method instead of writeArrayBlock(String, short[], long) if the total size of the data set is not a multiple of the block size.

Specified by:

writeArrayBlockWithOffset in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. The length defines the block size. Must not be null or of length 0.

dataSize - The (real) size of data (needs to be <= data.length )

offset - The offset in the data set to start writing to.

writeMatrix

void writeMatrix(java.lang.String objectPath,
               short[][] data)

Writes out a short matrix (array of rank 2).

Specified by:

writeMatrix in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

writeMatrix

void writeMatrix(java.lang.String objectPath,
               short[][] data,
               HDF5IntStorageFeatures features)

Writes out a short matrix (array of rank 2).

Specified by:

writeMatrix in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

features - The storage features of the data set.

createMatrix

void createMatrix(java.lang.String objectPath,
                int sizeX,
                int sizeY)

Creates a short matrix (array of rank 2).

Specified by:

createMatrix in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

sizeX - The size of one block in the x dimension. See createMDArray(String, int[]) on the different meanings of this parameter.

sizeY - The size of one block in the y dimension. See createMDArray(String, int[]) on the different meanings of this parameter.

createMatrix

void createMatrix(java.lang.String objectPath,
                int sizeX,
                int sizeY,
                HDF5IntStorageFeatures features)

Creates a short matrix (array of rank 2).

Specified by:

createMatrix in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

sizeX - The size of one block in the x dimension. See createMDArray(String, int[], HDF5IntStorageFeatures) on the different meanings of this parameter.

sizeY - The size of one block in the y dimension. See createMDArray(String, int[], HDF5IntStorageFeatures) on the different meanings of this parameter.

features - The storage features of the data set.

createMatrix

void createMatrix(java.lang.String objectPath,
                long sizeX,
                long sizeY,
                int blockSizeX,
                int blockSizeY)

Creates a short matrix (array of rank 2).

Specified by:

createMatrix in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

sizeX - The size of the x dimension of the short matrix to create.

sizeY - The size of the y dimension of the short matrix to create.

blockSizeX - The size of one block in the x dimension.

blockSizeY - The size of one block in the y dimension.

createMatrix

void createMatrix(java.lang.String objectPath,
                long sizeX,
                long sizeY,
                int blockSizeX,
                int blockSizeY,
                HDF5IntStorageFeatures features)

Creates a short matrix (array of rank 2).

Specified by:

createMatrix in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

sizeX - The size of the x dimension of the short matrix to create.

sizeY - The size of the y dimension of the short matrix to create.

blockSizeX - The size of one block in the x dimension.

blockSizeY - The size of one block in the y dimension.

features - The storage features of the data set.

writeMatrixBlock

void writeMatrixBlock(java.lang.String objectPath,
                    short[][] data,
                    long blockNumberX,
                    long blockNumberY)

Writes out a block of a short matrix (array of rank 2). The data set needs to have been created by createMatrix(String, long, long, int, int, HDF5IntStorageFeatures) beforehand.

Use this method instead of createMatrix(String, long, long, int, int, HDF5IntStorageFeatures) if the total size of the data set is not a multiple of the block size.

Specified by:

writeMatrixBlock in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. The length defines the block size. Must not be null or of length 0.

blockNumberX - The block number in the x dimension (offset: multiply with data.length).

blockNumberY - The block number in the y dimension (offset: multiply with data[0.length).

writeMatrixBlockWithOffset

void writeMatrixBlockWithOffset(java.lang.String objectPath,
                              short[][] data,
                              long offsetX,
                              long offsetY)

Writes out a block of a short matrix (array of rank 2). The data set needs to have been created by createMatrix(String, long, long, int, int, HDF5IntStorageFeatures) beforehand.

Use this method instead of writeMatrixBlock(String, short[][], long, long) if the total size of the data set is not a multiple of the block size.

Specified by:

writeMatrixBlockWithOffset in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write.

offsetX - The x offset in the data set to start writing to.

offsetY - The y offset in the data set to start writing to.

writeMatrixBlockWithOffset

void writeMatrixBlockWithOffset(java.lang.String objectPath,
                              short[][] data,
                              int dataSizeX,
                              int dataSizeY,
                              long offsetX,
                              long offsetY)

Writes out a block of a short matrix (array of rank 2). The data set needs to have been created by createMatrix(String, long, long, int, int, HDF5IntStorageFeatures) beforehand.

Use this method instead of writeMatrixBlock(String, short[][], long, long) if the total size of the data set is not a multiple of the block size.

Specified by:

writeMatrixBlockWithOffset in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write.

dataSizeX - The (real) size of data along the x axis (needs to be <= data.length )

dataSizeY - The (real) size of data along the y axis (needs to be <= data[0].length )

offsetX - The x offset in the data set to start writing to.

offsetY - The y offset in the data set to start writing to.

writeMDArray

void writeMDArray(java.lang.String objectPath,
                MDShortArray data)

Writes out a multi-dimensional short array.

Specified by:

writeMDArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

writeMDArray

void writeMDArray(java.lang.String objectPath,
                MDShortArray data,
                HDF5IntStorageFeatures features)

Writes out a multi-dimensional short array.

Specified by:

writeMDArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

features - The storage features of the data set.

writeMDArraySlice

void writeMDArraySlice(java.lang.String objectPath,
                     MDShortArray data,
                     IndexMap boundIndices)

Writes out a slice of a multi-dimensional short array. The slice is defined by "bound indices", each of which is fixed to a given value. The data object only contains the free (i.e. non-fixed) indices.

Note:The object identified by objectPath needs to exist when this method is called. This method will not create the array.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

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.

writeMDArraySlice

void writeMDArraySlice(java.lang.String objectPath,
                     MDShortArray data,
                     long[] boundIndices)

Writes out a slice of a multi-dimensional short array. The slice is defined by "bound indices", each of which is fixed to a given value. The data object only contains the free (i.e. non-fixed) indices.

Note:The object identified by objectPath needs to exist when this method is called. This method will not create the array.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

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.

createMDArray

void createMDArray(java.lang.String objectPath,
                 int[] dimensions)

Creates a multi-dimensional short array.

Specified by:

createMDArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

dimensions - When the writer is configured to use extendable data types (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial dimensions and the dimensions of a chunk of the array will be dimensions. When the writer is configured to enforce a non-extendable data set, the initial dimensions equal the dimensions and will be dimensions.

createMDArray

void createMDArray(java.lang.String objectPath,
                 long[] dimensions,
                 int[] blockDimensions)

Creates a multi-dimensional short array.

Specified by:

createMDArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

dimensions - The dimensions of the array.

blockDimensions - The dimensions of one block (chunk) of the array.

createMDArray

void createMDArray(java.lang.String objectPath,
                 int[] dimensions,
                 HDF5IntStorageFeatures features)

Creates a multi-dimensional short array.

Specified by:

createMDArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

dimensions - The dimensions of the short array to create. When requesting a chunked data set (e.g. HDF5IntStorageFeatures.INT_CHUNKED), the initial size of the array will be 0 and the chunk size will be dimensions. When allowing a chunked data set (e.g. HDF5IntStorageFeatures.INT_NO_COMPRESSION when the writer is not configured to avoid extendable data types, see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial size and the chunk size of the array will be dimensions. When enforcing a on-extendable data set (e.g. HDF5IntStorageFeatures.INT_CONTIGUOUS), the initial size equals the total size and will be dimensions.

features - The storage features of the data set.

createMDArray

void createMDArray(java.lang.String objectPath,
                 long[] dimensions,
                 int[] blockDimensions,
                 HDF5IntStorageFeatures features)

Creates a multi-dimensional short array.

Specified by:

createMDArray in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

dimensions - The dimensions of the array.

blockDimensions - The dimensions of one block (chunk) of the array.

features - The storage features of the data set.

writeMDArrayBlock

void writeMDArrayBlock(java.lang.String objectPath,
                     MDShortArray data,
                     long[] blockNumber)

Writes out a block of a multi-dimensional short array.

Specified by:

writeMDArrayBlock in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

blockNumber - The block number in each dimension (offset: multiply with the extend in the according dimension).

writeSlicedMDArrayBlock

void writeSlicedMDArrayBlock(java.lang.String objectPath,
                           MDShortArray data,
                           long[] blockNumber,
                           IndexMap boundIndices)

Writes out a sliced block of a multi-dimensional short array. The slice is defined by "bound indices", each of which is fixed to a given value. The data object only contains the free (i.e. non-fixed) indices.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

blockNumber - The block number in each dimension (offset: multiply with the extend 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.

writeSlicedMDArrayBlock

void writeSlicedMDArrayBlock(java.lang.String objectPath,
                           MDShortArray data,
                           long[] blockNumber,
                           long[] boundIndices)

Writes out a sliced block of a multi-dimensional short array. The slice is defined by "bound indices", each of which is fixed to a given value. The data object only contains the free (i.e. non-fixed) indices.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

blockNumber - The block number in each dimension (offset: multiply with the extend 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.

writeMDArrayBlockWithOffset

void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                               MDShortArray data,
                               long[] offset)

Writes out a block of a multi-dimensional short array.

Specified by:

writeMDArrayBlockWithOffset in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

offset - The offset in the data set to start writing to in each dimension.

writeSlicedMDArrayBlockWithOffset

void writeSlicedMDArrayBlockWithOffset(java.lang.String objectPath,
                                     MDShortArray data,
                                     long[] offset,
                                     IndexMap boundIndices)

Writes out a sliced block of a multi-dimensional short array. The slice is defined by "bound indices", each of which is fixed to a given value. The data object only contains the free (i.e. non-fixed) indices.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

offset - The offset in the data set to start writing to 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.

writeSlicedMDArrayBlockWithOffset

void writeSlicedMDArrayBlockWithOffset(java.lang.String objectPath,
                                     MDShortArray data,
                                     long[] offset,
                                     long[] boundIndices)

Writes out a sliced block of a multi-dimensional short array. The slice is defined by "bound indices", each of which is fixed to a given value. The data object only contains the free (i.e. non-fixed) indices.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null. All columns need to have the same length.

offset - The offset in the data set to start writing to 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.

writeMDArrayBlockWithOffset

void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                               MDShortArray data,
                               int[] blockDimensions,
                               long[] offset,
                               int[] memoryOffset)

Writes out a block of a multi-dimensional short array.

Specified by:

writeMDArrayBlockWithOffset in interface IHDF5UnsignedShortWriter

Parameters:

objectPath - The name (including path information) of the data set object in the file.

data - The data to write. Must not be null.

blockDimensions - The dimensions of the block to write to the data set.

offset - The offset of the block in the data set to start writing to in each dimension.

memoryOffset - The offset of the block in the data array.