H5Rget_region: Return selection for a reference to dataset region

View source: R/H5R.R

H5Rget_regionR Documentation

Return selection for a reference to dataset region

Description

Given a dataset region reference, this function will return the dataspace and selection required to read the data points indicated by the reference.

Usage

H5Rget_region(ref, h5loc)

Arguments

ref

An object of class H5Ref. This function is only valid for reference of type H5R_DATASET_REGION, and not H5R_OBJECT.

h5loc

An H5IdComponent object representing the file containing the referenced object.

Value

An object of class H5IdComponent representing the dataspace of the dataset that ref points to. The dataspace will have the selection set that matches the selection pointed to by ref. This should be closed using H5Sclose() when no longer required.


grimbough/rhdf5 documentation built on Sept. 14, 2024, 8:41 a.m.