mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-27 04:09:40 +03:00
316 lines
9.7 KiB
HTML
316 lines
9.7 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
|
|
<meta name="generator" content="Doxygen 1.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: HDF5 Table Specification Version 1.0</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="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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&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="hdf5doxy.css" rel="stylesheet" type="text/css"/>
|
|
-->
|
|
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
|
|
</head>
|
|
<body>
|
|
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
|
|
 <span id="projectnumber">1.15.0.33bb197</span>
|
|
</div>
|
|
<div id="projectbrief">API Reference</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.10.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
</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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('_t_b_l.html',''); initResizable(); });
|
|
/* @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 Table Specification Version 1.0</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><html>
|
|
<head>
|
|
<title>HDF5 Table Specification</title>
|
|
</head>
|
|
|
|
The HDF5 specification defines the standard objects and storage for the
|
|
standard HDF5 objects. (For information about the HDF5 library, model and
|
|
specification, see the HDF documentation.) This document is an additional
|
|
specification do define a standard profile for how to store tables in HDF5.
|
|
Table data in HDF5 is stored as HDF5 datasets with standard attributes to define
|
|
the properties of the tables.
|
|
|
|
<h2>
|
|
1. Overview</h2>
|
|
A generic table is a sequence of records, each record has a name and a type.
|
|
Table data is stored as an HDF5 one dimensional compound dataset. A table
|
|
is defined as a collection of records whose values are stored in fixed-length
|
|
fields. All records have the same structure and all values in each field have
|
|
the same data type.
|
|
<p>The dataset for a table is distinguished from other datasets by giving
|
|
it an attribute "CLASS=TABLE".
|
|
Optional attributes allow the storage of a title for the Table and for
|
|
each column, and a fill value for each column.
|
|
<h2>
|
|
2. Table Attributes</h2>
|
|
The attributes for the Table are strings. They are written with the <a href="RM_H5LT.html#H5LTset_attribute_string"><code>H5LTset_attribute_string</code></a>
|
|
Lite API function. "Required" attributes must always be used. "Optional" attributes
|
|
must be used when required.
|
|
<br>
|
|
<h4>
|
|
Attributes</h4>
|
|
|
|
<dl>
|
|
<dt>
|
|
Attribute name="<b>CLASS</b>" (Required)</dt>
|
|
|
|
<dd>
|
|
This attribute is type H5T_C_S1, with size 5.</dd>
|
|
|
|
<dd>
|
|
For all Tables, the value of this attribute is "TABLE".</dd>
|
|
|
|
<dd>
|
|
This attribute identifies this data set as intended to be interpreted as Table that conforms to the specifications on this page.</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
Attribute name="<b>VERSION</b>" (Required)
|
|
|
|
<dd>
|
|
This attribute is of type H5T_C_S1, with size corresponding to the length
|
|
of the version string. This attribute identifies the version number
|
|
of this specification to which it conforms. The current version number
|
|
is "0.2".</dd>
|
|
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>
|
|
Attribute name="<b>TITLE</b>" (Optional)</dt>
|
|
|
|
<dd>
|
|
The <b>TITLE</b> is an optional String that is to be used as the
|
|
informative title of the whole table.
|
|
The <b>TITLE</b> is set with the parameter <code> table_title</code> of the function
|
|
<a href="RM_H5TB.html#H5TBmake_table"> <code> H5TBmake_table</code></a>. </dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>
|
|
Attribute name="<b>FIELD_(n)_NAME</b>" (Required)</dt>
|
|
|
|
<dd>
|
|
The <b>FIELD_(n)_NAME</b> is an optional String that is to be used as the
|
|
informative title of column <b>n</b> of the table.
|
|
For each of the fields the word FIELD_ is concatenated with
|
|
the zero based field (n) index together with the name of the field.</dd>
|
|
|
|
</dl>
|
|
<dl>
|
|
<dt>
|
|
Attribute name="<b>FIELD_(n)_FILL</b>" (Optional)</dt>
|
|
|
|
<dd>
|
|
The <b>FIELD_(n)_FILL</b> is an optional String that is the fill value for
|
|
column <b>n</b> of the table.
|
|
For each of the fields the word FIELD_ is concatenated with
|
|
the zero based field (n) index together with the fill value, if present.
|
|
This value is written only when a fill value is defined for the table.</dd>
|
|
|
|
</dl>
|
|
|
|
<dl>
|
|
|
|
<br>
|
|
<center><table BORDER=2 BGCOLOR="#FFFFFF" >
|
|
<caption><b>Table 1. Attributes of an Image Dataset</b></caption>
|
|
|
|
<tr>
|
|
<td><b>Attribute Name</b></td>
|
|
|
|
<td><b>(R = Required</b>
|
|
<br><b>O= Optional)</b></td>
|
|
|
|
<td><b>Type</b></td>
|
|
|
|
<td><b>String Size</b></td>
|
|
|
|
<td><b>Value</b></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>CLASS</td>
|
|
|
|
<td>R</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>5</td>
|
|
|
|
<td>"TABLE"</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>VERSION</td>
|
|
|
|
<td>R</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>3</td>
|
|
|
|
<td>"0.2"</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>TITLE</td>
|
|
|
|
<td>O</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td> </td>
|
|
|
|
<td>
|
|
|
|
<tr>
|
|
<td>FIELD_(n)_NAME</td>
|
|
|
|
<td>R</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td> </td>
|
|
|
|
<td>
|
|
|
|
|
|
<tr>
|
|
<td>FIELD_(n)_FILL</td>
|
|
|
|
<td>O*</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td> </td>
|
|
|
|
<td>
|
|
|
|
</table>
|
|
</center>
|
|
|
|
</dl>
|
|
<p>
|
|
<center>
|
|
|
|
</center>
|
|
<i>* </i>The attribute FIELD_(n)_FILL is written to the table if a fill value is
|
|
specified on the creation of the Table. Otherwise, it is not.<p>The following
|
|
section of code shows the calls necessary to the creation of a table.
|
|
|
|
<p><code>/* Create a new HDF5 file using default properties. */<br>
|
|
file_id = H5Fcreate( "my_table.h5", H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT );</code> </p>
|
|
|
|
<p><code>/* Call the make table function */<br>
|
|
</code> <code>H5TBmake_table( "Table Title", file_id, "Table1", NFIELDS, NRECORDS, dst_size, <br>
|
|
field_names, dst_offset, field_type, <br>
|
|
chunk_size, fill_data, compress, p_data ) </code> </p>
|
|
|
|
<p><code> /* Close the file. */<br>
|
|
status = H5Fclose( file_id );</code> </p>
|
|
|
|
</body>
|
|
</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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|