Class H5Dataset
An HDF5 dataset.
Inherited Members
Namespace: HDF5.NET
Assembly: HDF5.NET.dll
Syntax
public class H5Dataset : H5AttributableObject
Properties
| Improve this Doc View SourceFile
A reference to the H5File that this dataset belongs to.
Declaration
public H5File File { get; }
Property Value
Type | Description |
---|---|
H5File |
FillValue
Gets the fill value.
Declaration
public H5FillValue FillValue { get; }
Property Value
Type | Description |
---|---|
H5FillValue |
Layout
Gets the data layout.
Declaration
public H5DataLayout Layout { get; }
Property Value
Type | Description |
---|---|
H5DataLayout |
Space
Gets the data space.
Declaration
public H5Dataspace Space { get; }
Property Value
Type | Description |
---|---|
H5Dataspace |
Type
Gets the data type.
Declaration
public H5DataType Type { get; }
Property Value
Type | Description |
---|---|
H5DataType |
Methods
| Improve this Doc View SourceAsQueryable<T>(Selection, UInt64[], H5DatasetAccess)
Queries the data. More information: HDF5.NET.
Declaration
public IQueryable<T> AsQueryable<T>(Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
where T : struct
Parameters
Type | Name | Description |
---|---|---|
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Returns
Type | Description |
---|---|
System.Linq.IQueryable<T> | A queryable of type |
Type Parameters
Name | Description |
---|---|
T | The type of the data to read. |
Read(Selection, Selection, UInt64[], H5DatasetAccess)
Reads the data.
Declaration
public byte[] Read(Selection fileSelection = null, Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
Parameters
Type | Name | Description |
---|---|---|
Selection | fileSelection | The selection within the source HDF5 dataset. |
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Returns
Type | Description |
---|---|
System.Byte[] | The read data as array of System.Byte. |
Read<T>(Selection, Selection, UInt64[], H5DatasetAccess)
Reads the data. The type parameter T
must match the langword_csharp_unmanaged constraint.
Declaration
public T[] Read<T>(Selection fileSelection = null, Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
where T : struct
Parameters
Type | Name | Description |
---|---|---|
Selection | fileSelection | The selection within the source HDF5 dataset. |
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Returns
Type | Description |
---|---|
T[] | The read data as array of |
Type Parameters
Name | Description |
---|---|
T | The type of the data to read. |
Read<T>(Memory<T>, Selection, Selection, UInt64[], H5DatasetAccess)
Reads the data. The type parameter T
must match the langword_csharp_unmanaged constraint.
Declaration
public void Read<T>(Memory<T> buffer, Selection fileSelection = null, Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
where T : struct
Parameters
Type | Name | Description |
---|---|---|
System.Memory<T> | buffer | The target memory buffer. |
Selection | fileSelection | The selection within the source HDF5 dataset. |
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Type Parameters
Name | Description |
---|---|
T | The type of the data to read. |
ReadCompound(Selection, Selection, UInt64[], H5DatasetAccess)
Reads the compound data. This is the slowest but most flexible option to read compound data as no prior type knowledge is required.
Declaration
public Dictionary<string, object>[] ReadCompound(Selection fileSelection = null, Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
Parameters
Type | Name | Description |
---|---|---|
Selection | fileSelection | The selection within the source HDF5 dataset. |
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Returns
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.Object>[] | The read data as array of a dictionary with the keys corresponding to the compound member names and the values being the member data. |
ReadCompound<T>(Func<FieldInfo, String>, Selection, Selection, UInt64[], H5DatasetAccess)
Reads the compound data. The type parameter T
must match the langword_csharp_struct constraint. Nested fields with nullable references are not supported.
Declaration
public T[] ReadCompound<T>(Func<FieldInfo, string> getName = null, Selection fileSelection = null, Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
where T : struct
Parameters
Type | Name | Description |
---|---|---|
System.Func<System.Reflection.FieldInfo, System.String> | getName | An optional function to map the field names of |
Selection | fileSelection | The selection within the source HDF5 dataset. |
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Returns
Type | Description |
---|---|
T[] | The read data as array of |
Type Parameters
Name | Description |
---|---|
T | The type of the data to read. |
ReadString(Selection, Selection, UInt64[], H5DatasetAccess)
Reads the string data.
Declaration
public string[] ReadString(Selection fileSelection = null, Selection memorySelection = null, ulong[] memoryDims = null, H5DatasetAccess datasetAccess = default(H5DatasetAccess))
Parameters
Type | Name | Description |
---|---|---|
Selection | fileSelection | The selection within the source HDF5 dataset. |
Selection | memorySelection | The selection within the target memory. |
System.UInt64[] | memoryDims | The dimensions of the target memory buffer. |
H5DatasetAccess | datasetAccess | The dataset access properties. |
Returns
Type | Description |
---|---|
System.String[] | The read data as array of System.String. |