H5DatasetCollectionAdd Method (String, BaseArray, BaseArray, Type, Object, H5Compression, UInt32)

public H5Dataset Add(
	string name,
	BaseArray data,
	BaseArray maxdims = null,
	Type datatype = null,
	Object fillvalue = null,
	H5Compression compression = H5Compression.None,
	uint compParameter = 8
)

Public Function Add ( 
	name As String,
	data As BaseArray,
	Optional maxdims As BaseArray = Nothing,
	Optional datatype As Type = Nothing,
	Optional fillvalue As Object = Nothing,
	Optional compression As H5Compression = H5Compression.None,
	Optional compParameter As UInteger = 8
) As H5Dataset

Dim instance As H5DatasetCollection
Dim name As String
Dim data As BaseArray
Dim maxdims As BaseArray
Dim datatype As Type
Dim fillvalue As Object
Dim compression As H5Compression
Dim compParameter As UInteger
Dim returnValue As H5Dataset

returnValue = instance.Add(name, data, 
	maxdims, datatype, fillvalue, compression, 
	compParameter)

Parameters

name

Type: SystemString
The name used to identify the new dataset in the group. Names must be unique among all objects in a group.

data

Type: ILNumericsBaseArray
Initial data array. This determines the space allocated initially in the file. This parameter cannot be null.

maxdims (Optional)

Type: ILNumericsBaseArray
[Optional] Maximum sizes for all dimensions the hdf5 file can grow. Default: unlimited.

datatype (Optional)

Type: SystemType
[Optional] Datatype used to store elements in the HDF5 file. If defined, this will override the datatype defined by data.

fillvalue (Optional)

Type: SystemObject
[Optional] Fillvalue used for undefined element values. Default: the default fill value defined by the HDF5 library (commonly: 0) will be used.

compression (Optional)

Type: ILNumerics.IO.HDF5H5Compression

compParameter (Optional)

Type: SystemUInt32

Return Value

This method creates a new dataset in the current group and use it to store the array given by the data parameter.

Datasets are always created as chunked datasets. By default, all existing datasets are expandable. In order to limit the maximum size for the dimensions of a dataset, the maxdims parameter allows the definition of maximum dimension length. maxdims expects a one dimensional array (vector) of any numeric type with the maximum dimension length for every existing dimension. Only those dimensions will be considered, which exist in both: maxdims and data. Unspecified dimensions are set to unlimited lenght. In order to mark a dimension as unlimited, a value of -1 must be used for the corresponding entry in maxdims. By default, maxdims is null which indicates unlimited length for all dimensions.

Fill value: Leave this parameter at its default (null) in order to have HDF5 use the default fill value. In most cases this will cause 0 (zero) to be used.

[ILNumerics HDF5 Module]

Reference