Files
hdf5/develop/namespaceh5ds.html
T
2024-02-09 17:39:10 +00:00

161 lines
12 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: h5ds Module Reference</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&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="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>
&#160;<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()">&#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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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>
</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('namespaceh5ds.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 class="header">
<div class="summary">
<a href="#func-members">Functions/Subroutines</a> </div>
<div class="headertitle"><div class="title">h5ds Module Reference<div class="ingroups"><a class="el" href="group___f_h5_d_s.html">Fortran High Level Dimension Scales (H5DS) Interface</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>This module contains Fortran interfaces for H5DS.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions/Subroutines</h2></td></tr>
<tr class="memitem:gaeb5d3e43c9934bb2fe7e3dbdec534417" id="r_gaeb5d3e43c9934bb2fe7e3dbdec534417"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#gaeb5d3e43c9934bb2fe7e3dbdec534417">h5dsset_scale_f</a> (dsid, errcode, dimname)</td></tr>
<tr class="memdesc:gaeb5d3e43c9934bb2fe7e3dbdec534417"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert dataset <code>dsid</code> to a dimension scale, with optional name, <code>dimname</code>. <br /></td></tr>
<tr class="separator:gaeb5d3e43c9934bb2fe7e3dbdec534417"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50588af3875bff680ae903a55a3f0cdf" id="r_ga50588af3875bff680ae903a55a3f0cdf"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga50588af3875bff680ae903a55a3f0cdf">h5dsattach_scale_f</a> (did, dsid, idx, errcode)</td></tr>
<tr class="memdesc:ga50588af3875bff680ae903a55a3f0cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach dimension scale dsid to dimension <code>idx</code> of dataset <code>did</code>. <br /></td></tr>
<tr class="separator:ga50588af3875bff680ae903a55a3f0cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15843c184487bf78bd73eef0c4693c5e" id="r_ga15843c184487bf78bd73eef0c4693c5e"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga15843c184487bf78bd73eef0c4693c5e">h5dsdetach_scale_f</a> (did, dsid, idx, errcode)</td></tr>
<tr class="memdesc:ga15843c184487bf78bd73eef0c4693c5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detach dimension scale dsid from the dimension idx of dataset <code>did</code>. <br /></td></tr>
<tr class="separator:ga15843c184487bf78bd73eef0c4693c5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19cad5f337c36e2ac26bd5f3809e6567" id="r_ga19cad5f337c36e2ac26bd5f3809e6567"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga19cad5f337c36e2ac26bd5f3809e6567">h5dsis_attached_f</a> (did, dsid, idx, is_attached, errcode)</td></tr>
<tr class="memdesc:ga19cad5f337c36e2ac26bd5f3809e6567"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report if dimension scale dsid is currently attached to dimension idx of dataset did. <br /></td></tr>
<tr class="separator:ga19cad5f337c36e2ac26bd5f3809e6567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6640937911372482b872e03b80fbad88" id="r_ga6640937911372482b872e03b80fbad88"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga6640937911372482b872e03b80fbad88">h5dsis_scale_f</a> (did, is_scale, errcode)</td></tr>
<tr class="memdesc:ga6640937911372482b872e03b80fbad88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether <code>did</code> is a Dimension Scale. <br /></td></tr>
<tr class="separator:ga6640937911372482b872e03b80fbad88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f9cb5b5f8f5eb1e1b3c069038a1674d" id="r_ga7f9cb5b5f8f5eb1e1b3c069038a1674d"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga7f9cb5b5f8f5eb1e1b3c069038a1674d">h5dsset_label_f</a> (did, idx, label, errcode)</td></tr>
<tr class="memdesc:ga7f9cb5b5f8f5eb1e1b3c069038a1674d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set label for the dimension <code>idx</code> of <code>did</code> to the value <code>label</code>. <br /></td></tr>
<tr class="separator:ga7f9cb5b5f8f5eb1e1b3c069038a1674d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12ed0456a8ac947465dd2a427eff6917" id="r_ga12ed0456a8ac947465dd2a427eff6917"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga12ed0456a8ac947465dd2a427eff6917">h5dsget_label_f</a> (did, idx, label, size, errcode)</td></tr>
<tr class="memdesc:ga12ed0456a8ac947465dd2a427eff6917"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the <code>label</code> for dimension <code>idx</code> of <code>did</code> into buffer <code>label</code>. <br /></td></tr>
<tr class="separator:ga12ed0456a8ac947465dd2a427eff6917"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb9f29853c60e6ee68846cfc22167c3b" id="r_gaeb9f29853c60e6ee68846cfc22167c3b"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#gaeb9f29853c60e6ee68846cfc22167c3b">h5dsget_scale_name_f</a> (did, name, size, errcode)</td></tr>
<tr class="memdesc:gaeb9f29853c60e6ee68846cfc22167c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the name of scale <code>did</code> into buffer name. <br /></td></tr>
<tr class="separator:gaeb9f29853c60e6ee68846cfc22167c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga229397f9f94eb63f1491863a3042cdc4" id="r_ga229397f9f94eb63f1491863a3042cdc4"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga229397f9f94eb63f1491863a3042cdc4">h5dsget_num_scales_f</a> (did, idx, num_scales, errcode)</td></tr>
<tr class="memdesc:ga229397f9f94eb63f1491863a3042cdc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how many Dimension Scales are attached to dimension idx of <code>did</code>. <br /></td></tr>
<tr class="separator:ga229397f9f94eb63f1491863a3042cdc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This module contains Fortran interfaces for H5DS. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceh5ds.html">h5ds</a></li>
<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>