Class HyperslabSelection

Namespace

PureHDF.Selections

Assembly

PureHDF.dll

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

public class HyperslabSelection : Selection

Inheritance

object

Selection

HyperslabSelection

Constructors

HyperslabSelection(int, ulong[], ulong[])

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

public HyperslabSelection(int rank, ulong[] starts, ulong[] blocks)

Parameters

rank int

The rank of the selection.

starts ulong[]

The start coordinate of the block along each dimension.

blocks ulong[]

The block size along each dimension.

HyperslabSelection(int, ulong[], ulong[], ulong[], ulong[])

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

public HyperslabSelection(int rank, ulong[] starts, ulong[] strides, ulong[] counts, ulong[] blocks)

Parameters

rank int

The rank of the selection.

starts ulong[]

The start coordinate of the block along each dimension.

strides ulong[]

The number of elements to separate each block to be selected along each dimension.

counts ulong[]

The number of blocks to select along each dimension.

blocks ulong[]

The block size along each dimension.

HyperslabSelection(ulong, ulong)

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

public HyperslabSelection(ulong start, ulong block)

Parameters

start ulong

The start coordinate of the block.

block ulong

The block size.

HyperslabSelection(ulong, ulong, ulong, ulong)

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

public HyperslabSelection(ulong start, ulong stride, ulong count, ulong block)

Parameters

start ulong

The start coordinate of the block.

stride ulong

The number of elements to separate each block to be selected.

count ulong

The number of blocks to select.

block ulong

The block size.

Properties

Rank

Gets the rank of the selection.

public int Rank { get; }

Property Value

int

TotalElementCount

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

public override ulong TotalElementCount { get; }

Property Value

ulong

Methods

Walk(ulong[])

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

public override IEnumerable<Step> Walk(ulong[] limits)

Parameters

limits ulong[]

The dataset dimensions.

Returns

IEnumerable<Step>

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