mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
189 lines
13 KiB
HTML
189 lines
13 KiB
HTML
<!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.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: h5im 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="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">
|
|
$(function() { init_search(); });
|
|
</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"> Last Updated on 2026-09-02</span>
|
|
</div>
|
|
<div id="projectbrief">The HDF5 Field Guide</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.16.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<div id="main-nav">
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical 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 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" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></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()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- main-nav -->
|
|
</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">
|
|
$(function(){initNavTree('namespaceh5im.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<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="headertitle"><div class="title">h5im Module Reference<div class="ingroups"><a class="el" href="group___f_h5_i_m.html">Fortran High Level Images (H5IM) Interface</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This module contains Fortran interfaces for H5IM.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions/Subroutines</h2></td></tr>
|
|
<tr class="memitem:ga37655210991f287c570e619cfedc28bf" id="r_ga37655210991f287c570e619cfedc28bf"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga37655210991f287c570e619cfedc28bf">h5imget_image_info_f</a> (loc_id, dset_name, width, height, planes, interlace, npals, errcode)</td></tr>
|
|
<tr class="memdesc:ga37655210991f287c570e619cfedc28bf"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). <br /></td></tr>
|
|
<tr class="memitem:gac06e374ebd82535e70fd14d214dc3f32" id="r_gac06e374ebd82535e70fd14d214dc3f32"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#gac06e374ebd82535e70fd14d214dc3f32">h5imget_npalettes_f</a> (loc_id, image_name, npals, errcode)</td></tr>
|
|
<tr class="memdesc:gac06e374ebd82535e70fd14d214dc3f32"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of palettes associated to an image. <br /></td></tr>
|
|
<tr class="memitem:ga2069e82b8d26612f7e261ec90f7b45a2" id="r_ga2069e82b8d26612f7e261ec90f7b45a2"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga2069e82b8d26612f7e261ec90f7b45a2">h5imget_palette_f</a> (loc_id, image_name, pal_number, pal_data, errcode)</td></tr>
|
|
<tr class="memdesc:ga2069e82b8d26612f7e261ec90f7b45a2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the palette dataset. <br /></td></tr>
|
|
<tr class="memitem:ga84c037ebf29227878e876740156fe666" id="r_ga84c037ebf29227878e876740156fe666"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga84c037ebf29227878e876740156fe666">h5imget_palette_info_f</a> (loc_id, image_name, pal_number, pal_dims, errcode)</td></tr>
|
|
<tr class="memdesc:ga84c037ebf29227878e876740156fe666"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about a palette dataset (dimensions). <br /></td></tr>
|
|
<tr class="memitem:ga96ac5556029f5723899d3ed55e7cc419" id="r_ga96ac5556029f5723899d3ed55e7cc419"><td class="memItemLeft">integer function </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga96ac5556029f5723899d3ed55e7cc419">h5imis_image_f</a> (loc_id, dset_name)</td></tr>
|
|
<tr class="memdesc:ga96ac5556029f5723899d3ed55e7cc419"><td class="mdescLeft"> </td><td class="mdescRight">Inquires if a dataset is an image. <br /></td></tr>
|
|
<tr class="memitem:ga9ac7575820d1b75c6661a78107f2eec5" id="r_ga9ac7575820d1b75c6661a78107f2eec5"><td class="memItemLeft">integer function </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga9ac7575820d1b75c6661a78107f2eec5">h5imis_palette_f</a> (loc_id, dset_name)</td></tr>
|
|
<tr class="memdesc:ga9ac7575820d1b75c6661a78107f2eec5"><td class="mdescLeft"> </td><td class="mdescRight">Inquires if a dataset is a palette. Returns zero (false), a positive (true) or a negative (failure) value. <br /></td></tr>
|
|
<tr class="memitem:ga0986868cd2ddef408ac55d704b064a60" id="r_ga0986868cd2ddef408ac55d704b064a60"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga0986868cd2ddef408ac55d704b064a60">h5imlink_palette_f</a> (loc_id, image_name, pal_name, errcode)</td></tr>
|
|
<tr class="memdesc:ga0986868cd2ddef408ac55d704b064a60"><td class="mdescLeft"> </td><td class="mdescRight">This function attaches a palette to an existing image dataset. <br /></td></tr>
|
|
<tr class="memitem:gae17a8216ab5725dc684ed7baea996680" id="r_gae17a8216ab5725dc684ed7baea996680"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#gae17a8216ab5725dc684ed7baea996680">h5immake_image_24bit_f</a> (loc_id, dset_name, width, height, il, buf, errcode)</td></tr>
|
|
<tr class="memdesc:gae17a8216ab5725dc684ed7baea996680"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes an image a 24 bit image. <br /></td></tr>
|
|
<tr class="memitem:gac30cbab36df84de283e30d9de9bdc848" id="r_gac30cbab36df84de283e30d9de9bdc848"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#gac30cbab36df84de283e30d9de9bdc848">h5immake_image_8bit_f</a> (loc_id, dset_name, width, height, buf, errcode)</td></tr>
|
|
<tr class="memdesc:gac30cbab36df84de283e30d9de9bdc848"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes an image an 8 bit image. <br /></td></tr>
|
|
<tr class="memitem:ga8c66f1723f02ab514631b1ca448af532" id="r_ga8c66f1723f02ab514631b1ca448af532"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga8c66f1723f02ab514631b1ca448af532">h5immake_palette_f</a> (loc_id, pal_name, pal_dims, pal_data, errcode)</td></tr>
|
|
<tr class="memdesc:ga8c66f1723f02ab514631b1ca448af532"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes a palette. <br /></td></tr>
|
|
<tr class="memitem:gace5754228364bcde3e21d6d1cdb0cb5e" id="r_gace5754228364bcde3e21d6d1cdb0cb5e"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#gace5754228364bcde3e21d6d1cdb0cb5e">h5imread_image_f</a> (loc_id, dset_name, buf, errcode)</td></tr>
|
|
<tr class="memdesc:gace5754228364bcde3e21d6d1cdb0cb5e"><td class="mdescLeft"> </td><td class="mdescRight">Reads image data from disk. <br /></td></tr>
|
|
<tr class="memitem:ga6dfdaf798d1f36076aea143c1f23f8c2" id="r_ga6dfdaf798d1f36076aea143c1f23f8c2"><td class="memItemLeft">subroutine </td><td class="memItemRight"><a class="el" href="group___f_h5_i_m.html#ga6dfdaf798d1f36076aea143c1f23f8c2">h5imunlink_palette_f</a> (loc_id, image_name, pal_name, errcode)</td></tr>
|
|
<tr class="memdesc:ga6dfdaf798d1f36076aea143c1f23f8c2"><td class="mdescLeft"> </td><td class="mdescRight">This function detaches a palette to an existing image dataset. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This module contains Fortran interfaces for H5IM. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="namespaceh5im.html">h5im</a></li>
|
|
<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.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|