H5Dataset Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

This class represents HDF5 datasets. Is is used to create, manage, and access datasets stored in HDF5 files via ILNumerics.IO.HDF5.

[ILNumerics HDF5 Module]

Inheritance Hierarchy

SystemObject
  ILNumerics.IO.HDF5H5Object
    ILNumerics.IO.HDF5H5Dataset
      ILNumerics.IO.HDF5H5StringDataset

Namespace: ILNumerics.IO.HDF5
Assembly: ILNumerics.IO.HDF5 (in ILNumerics.IO.HDF5.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

public class H5Dataset : H5Object

Public Class H5Dataset
	Inherits H5Object

Dim instance As H5Dataset

The H5Dataset type exposes the following members.

Constructors

	Name	Description
	H5Dataset	Creates a new dataset. Optionally define additional parameters. [ILNumerics HDF5 Module]

Properties

	Name	Description
	Attributes	Gets access to the collection of attributes for this object. [ILNumerics HDF5 Module]
	Class	Gets the HDF5 base type used to store the elements. [ILNumerics HDF5 Module]
	Compression	Gets the compression method configured for the dataset [readonly]. [ILNumerics HDF5 Module]
	CompressionParameter	Additional parameter for compression method [readonly]. [ILNumerics HDF5 Module]
	File	The HDF5 file this object is originated from. [ILNumerics HDF5 Module] (Inherited from H5Object.)
	H5Type	Gets the object type of this dataset. This will always return 'H5ObjectTypes.Dataset'. [ILNumerics HDF5 Module] (Overrides H5ObjectH5Type.)
	MaxSize	The maximum dimension sizes configured [readonly]. [ILNumerics HDF5 Module]
	Name	Gets the local name of the object, i.e. the last segment from the absolute path [ILNumerics HDF5 Module] (Inherited from H5Object.)
	NameEncoding	Gets the local object name encoding type. [ILNumerics HDF5 Module] (Inherited from H5Object.)
	Path	Unique object identifier, commonly the absolute path to the object in the HDF5 file [ILNumerics HDF5 Module] (Inherited from H5Object.)
	Size	Gets the current size of the dataset [readonly]. [ILNumerics HDF5 Module]

Methods

	Name	Description
	Equals	(Inherited from H5Object.)
	GetT	Retrieve (sub-)array from dataset [ILNumerics HDF5 Module]
	GetFillValueT	Gives the user defined fill value for the data set. [ILNumerics HDF5 Module]
	GetHashCode	(Inherited from H5Object.)
	IsStringDataset
	SetT	Alter the existing data stored in the file or parts of it. [ILNumerics HDF5 Module]
	ToString	(Inherited from H5Object.)

Fields

Extension Methods

	Name	Description
	GetH5ID	Retrieves the object ID used to identify the object within the HDF5 file /// [ILNumerics HDF5 Module] (Defined by Helper.)

Remarks

[ILNumerics HDF5 Module]