mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-29 04:09:39 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
cdb45eb244c93ade2685bc752dc3aed73fc8bbd5
hdf5/develop/_u_g.html
T
byrnHDF cdb45eb244 deploy: e5f526b62d
2025-10-28 01:20:17 +00:00

690 lines
36 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: HDF5 User Guide</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeTabs.init()
</script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-57FMZK4S7X');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;Last Updated on 2025-10-28</span>
</div>
<div id="projectbrief">The HDF5 Field Guide</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_f_t_s.html"><span>Full-Text&#160;Search</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_u_g.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">HDF5 User Guide</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Navigate back: <a class="el" href="index.html">Main</a> </p><hr />
<p><a class="el" href="_h5_d_m__u_g.html#sec_data_model">The HDF5 Data Model and File Structure</a> </p><ul>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_intro">Introduction</a> </li>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_abstract">The Abstract Data Model</a> <ul>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_file">File</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_group">Group</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_dataset">Dataset</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_space">Dataspace</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_type">Datatype</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_attr">Attribute</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_plist">Property List</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_abstract_link">Link</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_storage">The HDF5 Storage Model</a> <ul>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_storage_spec">The Abstract Storage Model: the HDF5 Format Specification</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_storage_imple">Concrete Storage Model</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d_m__u_g.html#subsec_data_model_structure">The Structure of an HDF5 File</a> <ul>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_structure_file">Overall File Structure</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_structure_path">HDF5 Path Names and Navigation</a> </li>
<li>
<a class="el" href="_h5_d_m__u_g.html#subsubsec_data_model_structure_example">Examples of HDF5 File Structures</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5__u_g.html#sec_program">The HDF5 Library and Programming Model</a> </p><ul>
<li><a class="el" href="_h5__u_g.html#subsec_program_intro">Introduction</a> </li>
<li><a class="el" href="_h5__u_g.html#subsec_program_model">The HDF5 Programming Model</a> <ul>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_create">Creating an HDF5 File</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_dset">Creating and Initializing a Dataset</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_close">Closing an Object</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_data">Writing or Reading a Dataset to or from a File</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_partial">Reading and Writing a Portion of a Dataset</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_info">Getting Information about a Dataset</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_compound">Creating and Defining Compound Datatypes</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_extend">Creating and Writing Extendable Datasets</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_group">Creating and Working with Groups</a> </li>
<li>
<a class="el" href="_h5__u_g.html#subsubsec_program_model_attr">Working with Attributes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5__u_g.html#subsec_program_transfer_pipeline">The Data Transfer Pipeline</a></li>
</ul>
<p><a class="el" href="_h5_f__u_g.html#sec_file">The HDF5 File</a> </p><ul>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_intro">Introduction</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_access_modes">File Access Modes</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_creation_access">File Creation and File Access Properties</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_drivers">Low-level File Drivers</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_program_model">Programming Model for Files</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_program_model_create">Creating a New File</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_program_model_open">Opening an Existing File</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_program_model_close">Closing a File</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_h5dump">Using h5dump to View a File</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_summary">File Function Summaries</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_create">Creating or Opening an HDF5 File</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_closes">Closing an HDF5 File</a> </li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_property_lists">File Property Lists</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_property_lists_create">Creating a Property List</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_property_lists_props">File Creation Properties</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_property_lists_access">File Access Properties</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_alternate_drivers">Alternate File Storage Layouts and Low-level File Drivers</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_id">Identifying the Previously‐used File Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_sec2">The POSIX (aka SEC2) Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_direct">The Direct Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_log">The Log Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_win">The Windows Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_stdio">The STDIO Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_mem">The Memory (aka Core) Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_family">The Family Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_multi">The Multi Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_split">The Split Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_ros3">The ROS3 Driver</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_alternate_drivers_par">The Parallel Driver</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_examples">Code Examples for Opening and Closing Files</a> <ul>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_examples_trunc">Example Using the H5F_ACC_TRUNC Flag</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_examples_props">Example with the File Creation Property List</a> </li>
<li>
<a class="el" href="_h5_f__u_g.html#subsubsec_file_examples_access">Example with the File Access Property List</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f__u_g.html#subsec_file_multiple">Working with Multiple HDF5 Files</a></li>
</ul>
<p><a class="el" href="_h5_g__u_g.html#sec_group">HDF5 Groups</a> </p><ul>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_intro">Introduction</a> </li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_descr">Description of the Group Object</a> <ul>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_object">The Group Object</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_model">The Hierarchy of Data Objects</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_path">HDF5 Path Names</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_descr_impl">Group Implementations in HDF5</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_h5dump">Using h5dump</a> </li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_function">Group Function Summaries</a> </li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_program">Programming Model for Groups</a> <ul>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_create">Creating a Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_open">Opening a Group and Accessing an Object in that Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_dataset">Creating a Dataset in a Specific Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_close">Closing a Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_links">Creating Links</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_info">Discovering Information about Objects</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_objs">Discovering Objects in a Group</a> </li>
<li>
<a class="el" href="_h5_g__u_g.html#subsubsec_group_program_all">Discovering All of the Objects in the File</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_g__u_g.html#subsec_group_examples">Examples of File Structures</a></li>
</ul>
<p><a class="el" href="_h5_d__u_g.html#sec_dataset">HDF5 Datasets</a> </p><ul>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_intro">Introduction</a> </li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_function">Dataset Function Summaries</a> </li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_program">Programming Model for Datasets</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_general">General Model</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_create">Create Dataset</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_transfer">Data Transfer Operations on a Dataset</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_program_read">Retrieve the Properties of a Dataset</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_transfer">Data Transfer</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_pipe">The Data Pipeline</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_filter">Data Pipeline Filters</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_drive">File Drivers</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_props">Data Transfer Properties to Manage the Pipeline</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_store">Storage Strategies</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_partial">Partial I/O Sub‐setting and Hyperslabs</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_transfer_dyn_filter">Data Pipeline Dynamically Loaded Filters</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_allocation">Allocation of Space in the File</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_store">Storage Allocation in the File: Early, Incremental, Late</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_delete">Deleting a Dataset from a File and Reclaiming Space</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_release">Releasing Memory Resources</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_allocation_ext">External Storage Properties</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d__u_g.html#subsec_dataset_filters">Using HDF5 Filters</a> <ul>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_nbit">Using the N‐bit Filter</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_scale">Using the Scale‐offset Filter</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_szip">Using the SZip Filter</a> </li>
<li>
<a class="el" href="_h5_d__u_g.html#subsubsec_dataset_filters_dyn">Using Dynamically-Loadable Filters</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_t__u_g.html#sec_datatype">HDF5 Datatypes</a> </p><ul>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_intro">Introduction and Definitions</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_model">Datatype Model</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_model_class">Datatype Classes and Properties</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_model_predefine">Predefined Datatypes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_usage">How Datatypes are Used</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_object">The Datatype Object and the HDF5 Datatype API</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_create">Dataset Creation</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_transfer">Data Transfer (Read and Write)</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_discover">Discovery of Data Format</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_usage_user">Creating and Using User‐defined Datatypes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_function">Datatype Function Summaries</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_program">Programming Model for Datatypes</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_program_discover">Discovery of Datatype Properties</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_program_define">Definition of Datatypes</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_other">Other Non-numeric Datatypes</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_strings">Strings</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_refs">Reference</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_enum">ENUM</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_opaque">Opaque</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_other_bitfield">Bitfield</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_fill">Fill Values</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_complex">Complex Combinations of Datatypes</a> <ul>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_complex_create">Creating a Complicated Compound Datatype</a> </li>
<li>
<a class="el" href="_h5_t__u_g.html#subsubsec_datatype_complex_analyze">Analyzing and Navigating a Compound Datatype</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_life">Life Cycle of the Datatype Object</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_transfer">Data Transfer: Datatype Conversion and Selection</a> </li>
<li><a class="el" href="_h5_t__u_g.html#subsec_datatype_text">Text Descriptions of Datatypes: Conversion to and from</a></li>
</ul>
<p><a class="el" href="_h5_s__u_g.html#sec_dataspace">HDF5 Dataspaces and Partial I/O</a> </p><ul>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_intro">Introduction</a> </li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_function">Dataspace Function Summaries</a> </li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_program">Definition of Dataspace Objects and the Dataspace Programming Model</a> <ul>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_program_object">Dataspace Objects</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_program_model">Dataspace Programming Model</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_transfer">Dataspaces and Data Transfer</a> <ul>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_transfer_select">Data Selection</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_transfer_model">Programming Model</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_select">Dataspace Selection Operations and Data Transfer</a> </li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_refer">References</a> <ul>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_refer_use">Example Uses for Region References</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_refer_create">Creating References to Regions</a> </li>
<li>
<a class="el" href="_h5_s__u_g.html#subsubsec_dataspace_refer_read">Reading References to Regions</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_s__u_g.html#subsec_dataspace_sample">Sample Programs</a></li>
</ul>
<p><a class="el" href="_h5_a__u_g.html#sec_attribute">HDF5 Attributes</a> </p><ul>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_intro">Introduction</a> </li>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_program">Programming Model for Attributes</a> <ul>
<li>
To Open and Read or Write an Existing Attribute </li>
</ul>
</li>
<li><a class="el" href="_h5_a__u_g.html#subsec_error_H5A">Attribute Function Summaries</a> </li>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_work">Working with Attributes</a> <ul>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_struct">The Structure of an Attribute</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_create">Creating, Writing, and Reading Attributes</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_access">Accessing Attributes by Name or Index</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_info">Obtaining Information Regarding an Object's Attributes</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_iterate">Iterating across an Object's Attributes</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_delete">Deleting an Attribute</a> </li>
<li>
<a class="el" href="_h5_a__u_g.html#subsubsec_attribute_work_close">Closing an Attribute</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_a__u_g.html#subsec_attribute_special">Special Issues</a></li>
</ul>
<p><a class="el" href="_h5_e__u_g.html#sec_error">HDF5 Error Handling</a> </p><ul>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_intro">Introduction</a> </li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_program">Programming Model for Error Handling</a> </li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_H5E">Error Handling Function Summaries</a> </li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_ops">Basic Error Handling Operations</a> <ul>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_stack">Error Stack and Error Message</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_print">Print and Clear an Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_mute">Mute Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_custom_print">Customized Printing of an Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_walk">Walk through the Error Stack</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_ops_travers">Traverse an Error Stack with a Callback Function</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_e__u_g.html#subsec_error_adv">Advanced Error Handling Operations</a> <ul>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_adv_more">More Error API Functions</a> </li>
<li>
<a class="el" href="_h5_e__u_g.html#subsubsec_error_adv_app">Pushing an Application Error Message onto Error Stack</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_p__u_g.html#sec_plist">Properties and Property Lists in HDF5</a> </p><ul>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_intro">Introduction</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_class">Property List Classes, Property Lists, and Properties</a> <ul>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_class">Property List Classes</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_lists">Property Lists</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_props">Properties</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_program">Programming Model for Properties and Property Lists</a> <ul>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_default">Using Default Property Lists</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_basic">Basic Steps of the Programming Model</a> </li>
<li>
<a class="el" href="_h5_p__u_g.html#subsubsec_plist_additional">Additional Property List Operations</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_generic">Generic Properties Interface and User-defined Properties</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_H5P">Property List Function Summaries</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_resources">Additional Property List Resources</a> </li>
<li><a class="el" href="_h5_p__u_g.html#subsec_plist_notes">Notes</a></li>
</ul>
<p><a class="el" href="_h5_v_l__u_g.html#sec_vol">The HDF5 Virtual Object Layer (VOL)</a> </p><ul>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_intro">Introduction</a> </li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_abstract_layer">The VOL Abstraction Layer</a> </li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_quickstart">Quickstart</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_read">Read The Documentation For The New VOL Connector</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_use">Use A VOL-Enabled HDF5 Library</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_set">Determine How You Will Set The VOL Connector</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_update">If Needed: Update Your Code To Load And Use A VOL Connector</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_plugin">If Using A Plugin: Make Sure The VOL Connector Is In The Search</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_quick_opt">Optional: Set The VOL Connector Via The Environment Variable</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_connect">VOL Connectors</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_register">Registration</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_version">Connector Versioning</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_reg_calls">Connector-Specific Registration Calls</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_set_vol">H5Pset_vol()</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_search">VOL Connector Search Path</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_param">Parameter Strings</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_connect_env">Environment Variable</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_adapt">Adapting HDF5 Software to Use the VOL</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_adapt_token">haddr_t → H5O_token_t</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_adapt_api">Specific API Call Substitutions</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_adapt_native">Protect Native-Only API Calls</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_lang">Language Wrappers</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_lang_c">C++</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_lang_fort">Fortran</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_lang_java">Java/JNI</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_cl">Using VOL Connectors With The HDF5 Command-Line Tools</a> </li>
<li><a class="el" href="_h5_v_l__u_g.html#subsec_vol_compat">Compatibility</a> <ul>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_compat_native">List of HDF5 Native VOL API Calls</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_compat_indep">List of HDF5 VOL-Independent API Calls</a> </li>
<li>
<a class="el" href="_h5_v_l__u_g.html#subsubsec_vol_compat_opt">List of Native VOL Optional Operation Values By Subclass</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_f_i_m__u_g.html#sec_file_image">HDF5 File Image</a> </p><ul>
<li><a class="el" href="_h5_f_i_m__u_g.html#subsec_file_image_intro">Introduction to HDF5 File Image Operations</a> </li>
<li><a class="el" href="_h5_f_i_m__u_g.html#subsec_file_image_api">File Image C API Call Syntax</a> <ul>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_api_low">Low-level C API Routines</a> </li>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_api_high">High-level C API Routine</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f_i_m__u_g.html#subsec_file_image_semantics">C API Call Semantics</a> <ul>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_semantics_cbk">File Image Callback Semantics</a> </li>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_semantics_init">Initial File Image Semantics</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f_i_m__u_g.html#subsec_file_image_example">Examples</a> <ul>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_example_read">Reading an In-memory HDF5 File Image</a> </li>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_example_const">In-memory HDF5 File Image Construction</a> </li>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_example_dp">Using HDF5 to Construct and Read a Data Packet</a> </li>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_example_template">Using a Template File</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_f_i_m__u_g.html#subsec_file_image_java">Java Signatures for File Image Operations API Calls</a> </li>
<li><a class="el" href="_h5_f_i_m__u_g.html#subsec_file_image_fort">Fortran Signatures for File Image Operations API Calls</a> <ul>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_fort_low">Fortran Low-Level APIs</a> </li>
<li>
<a class="el" href="_h5_f_i_m__u_g.html#subsubsec_file_image_fort_high">Fortran High-Level APIs</a> </li>
</ul>
</li>
</ul>
<p><a class="el" href="_h5_e_s__u_g.html#sec_async">The HDF5 Event Set Interface</a> </p><ul>
<li><a class="el" href="_h5_e_s__u_g.html#subsec_async_intro">Introduction</a></li>
</ul>
<p><a class="el" href="_h5_m__u_g.html#sec_map">HDF5 Map Object</a></p>
<p><a class="el" href="_h5_r__u_g.html#sec_reference">HDF5 References</a></p>
<p><a class="el" href="_h5_p_l__u_g.html#sec_filter_plugins">HDF5 Filter Plugins</a></p>
<h1><a class="anchor" id="sec_hl"></a>
HDF5 High Level APIs</h1>
<ul>
<li><a class="el" href="_h5_d_o__u_g.html">HDF5 High Level Optimizations</a> <ul>
<li>
<a class="el" href="_h5_d_o__u_g.html#sec_hldo_direct_chunk">Direct Chunk Write Function</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_d_s__u_g.html">HDF5 High Level Dimension Scales</a> <ul>
<li>
<a class="el" href="_h5_d_s__u_g.html#sec_dim_scales_stand">HDF5 Standard for Dimension Scales</a> </li>
<li>
<a class="el" href="_h5_d_s__u_g.html#sec_dim_scales_concept">Conceptual model</a> </li>
<li>
<a class="el" href="_h5_d_s__u_g.html#sec_dim_scales_spec">The HDF5 Dimension Scale Specification</a> </li>
<li>
<a class="el" href="_h5_d_s__u_g.html#sec_dim_scales_api">Programming Model and API</a> </li>
</ul>
</li>
<li><a class="el" href="_h5_i_m__u_g.html">HDF5 High Level Images</a> </li>
<li><a class="el" href="_h5_l_t__u_g.html">HDF5 High Level Lite</a> </li>
<li><a class="el" href="_h5_t_b__u_g.html">HDF5 High Level Table</a> </li>
<li><a class="el" href="_h5_p_t__u_g.html">HDF5 High Level Packet Table</a></li>
</ul>
<h1><a class="anchor" id="sec_cltools"></a>
Command Line Tools for HDF5 Files</h1>
<ul>
<li><a class="el" href="_h5_t_o_o_l__c_p__u_g.html">The HDF5 h5copy Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__d_f__u_g.html">The HDF5 h5diff Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__d_p__u_g.html">The HDF5 h5dump Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__f_c__u_g.html">The HDF5 h5format_convert Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__i_m__u_g.html">The HDF5 h5import Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__j_a_m__u_g.html">The HDF5 h5jam/h5unjam Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__l_s__u_g.html">The HDF5 h5ls Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__r_p__u_g.html">The HDF5 h5repack Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__s_t__u_g.html">The HDF5 h5stat Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__c_r__u_g.html">The HDF5 h5clear Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__d_g__u_g.html">The HDF5 h5debug Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__d_t__u_g.html">The HDF5 h5delete Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__m_g__u_g.html">The HDF5 h5mkgrp Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__r_t__u_g.html">The HDF5 h5repart Tool</a> </li>
<li><a class="el" href="_h5_t_o_o_l__w_h__u_g.html">The HDF5 h5watch Tool</a></li>
</ul>
<p><a class="el" href="_a_r__u_g.html#sec_addition">Additional Resources</a></p>
<hr />
<p> Navigate back: <a class="el" href="index.html">Main</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink