HDF5 High-level Functions for Region References, Hyperslabs, and Bit-fields


The following reference manual entries describe high-level HDF5 C and Fortran APIs for working with region references, hyperslab selections, and bit-fields. These functions were created as part of a project supporting NPP/NPOESS Data Production and Exploitation (project, software). While they were written to facilitate access to NPP, NPOESS, and JPSS data in the HDF5 format, these functions may be useful to anyone working with region references, hyperslab selections, or bit-fields.

Note that these functions are not part of the standard HDF5 distribution; the software must be separately downloaded and installed. For documentation of the underlying HDF5 Library, see  http://www.hdfgroup.org/HDF5/doc.

A comprehensive guide to this library, User Guide to the HDF5 High-level Library for Handling Region References and Hyperslab Selections is available at http://www.hdfgroup.org/projects/npoess/HL_NPOESS/doc/UG/NPOESS_HL-UG.pdf.


Reference Manual


Region Reference APIs    Hyperslab APIs

Bit-field API

C Code Examples

Example    Description    Illustrated function(s)
ex_lite_read_region.c    Read a dataset region, given a set of corner coordinates    H5LTread_region
ex_regref_read.c    Create, store and read data associated with region references    H5LRget_region_info
H5LRread_region
ex_lite_copy_region.c    Copy a dataset region    H5LTcopy_region
ex_regref_copy_references.c    Copy a referenced region and create a new region reference to the copy    H5LRcopy_references
ex_regref_create.c    Create region references and create a new dataset composed of data from the referenced regions    H5LRcreate_region_references
ex_ref_to_all.c    Create and write a dataset of region references    H5LRcreate_ref_to_all
ex_bitfield.c    Read and write quality flag bit-fields    H5LTread_bitfield_value

FORTRAN Code Examples

Example    Description    Illustrated function(s)
ex_lite_read_region.f90    Read a dataset region, given a set of corner coordinates    H5LTread_region_f
ex_regref_read.f90    Create, store and read data associated with region references    H5LRget_region_info_f
H5LRread_region_f
ex_lite_copy_region.f90    Copy a dataset region    H5LTcopy_region_f
ex_regref_copy_reference.f90    Copy a referenced region and create a new region reference to the copy    H5LRcopy_references_f
ex_regref_create.f90    Create region references and create a new dataset composed of data from the referenced regions    H5LRcreate_region_references_f
ex_ref_to_all.f90    Create and write a dataset of region references    H5LRcreate_ref_to_all_f
ex_bitfield.f90    Read and write quality flag bit-fields    H5LTread_bitfield_value_f

RFCs




Region Reference APIs


(Top)
(Top)
(Top)
(Top)
(Top)
(Top)
(Top)


Hyperslab APIs


(Top)
(Top)


Bit-field API


(Top)

The HDF Group Help Desk:
Describes HDF5 High-Level Region and Hyperslab Functions Release 1.1, September 2010.
Last modified: 30 December 2010
Copyright by The HDF Group