Class HyperslabSelection

A hyperslab is a selection of elements from a hyper rectangle.

Inheritance
System.Object
Selection
HyperslabSelection
Namespace: HDF5.NET
Assembly: HDF5.NET.dll
Syntax
public class HyperslabSelection : Selection

Constructors

| Improve this Doc View Source

HyperslabSelection(Int32, UInt64[], UInt64[], UInt64[], UInt64[])

Initializes a new instance of the HyperslabSelection instance of rank rank. Reference: hdfgroup.org.

Declaration
public HyperslabSelection(int rank, ulong[] starts, ulong[] strides, ulong[] counts, ulong[] blocks)
Parameters
Type Name Description
System.Int32 rank
System.UInt64[] starts

The start coordinate of the block along each dimension.
System.UInt64[] strides

The number of elements to separate each block to be selected along each dimension.
System.UInt64[] counts

The number of blocks to select along each dimension.
System.UInt64[] blocks

The block size along each dimension.
| Improve this Doc View Source

HyperslabSelection(Int32, UInt64[], UInt64[])

Initializes a new instance of the HyperslabSelection instance of rank rank. Reference: hdfgroup.org.

Declaration
public HyperslabSelection(int rank, ulong[] starts, ulong[] blocks)
Parameters
Type Name Description
System.Int32 rank

The rank of the selection.
System.UInt64[] starts

The start coordinate of the block along each dimension.
System.UInt64[] blocks

The block size along each dimension.
| Improve this Doc View Source

HyperslabSelection(UInt64, UInt64, UInt64, UInt64)

Initializes a new instance of the HyperslabSelection instance of rank 1. Reference: hdfgroup.org.

Declaration
public HyperslabSelection(ulong start, ulong stride, ulong count, ulong block)
Parameters
Type Name Description
System.UInt64 start

The start coordinate of the block.
System.UInt64 stride

The number of elements to separate each block to be selected.
System.UInt64 count

The number of blocks to select.
System.UInt64 block

The block size.
| Improve this Doc View Source

HyperslabSelection(UInt64, UInt64)

Initializes a new instance of the HyperslabSelection instance of rank 1. Reference: hdfgroup.org.

Declaration
public HyperslabSelection(ulong start, ulong block)
Parameters
Type Name Description
System.UInt64 start

The start coordinate of the block.
System.UInt64 block

The block size.

Properties

| Improve this Doc View Source

Rank

Gets the rank of the selection.

Declaration
public int Rank { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TotalElementCount

Gets the total number of elements which is used to preallocate the returned buffer.

Declaration
public override ulong TotalElementCount { get; }
Property Value
Type Description
System.UInt64
Overrides

Methods

| Improve this Doc View Source

Walk(UInt64[])

The walk function is used to walk through the dataset and select the requested data.

Declaration
public override IEnumerable<Step> Walk(ulong[] limits)
Parameters
Type Name Description
System.UInt64[] limits

The dataset dimensions.
Returns
Type Description
System.Collections.Generic.IEnumerable<Step>

An enumerable which provides a sequence of steps to select the requested data.
Overrides