1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<!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.9.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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(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</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('namespaceh5im.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions/Subroutines</a> </div>
<div class="headertitle">
<div class="title">h5im Module Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This module contains Fortran interfaces for H5IM.
<a href="namespaceh5im.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions/Subroutines</h2></td></tr>
<tr class="memitem:gae6e02f37f9fc03eb338b3114e0c0cae1"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gae6e02f37f9fc03eb338b3114e0c0cae1">h5immake_image_8bit_f</a> (loc_id, dset_name, width, height, buf, errcode)</td></tr>
<tr class="memdesc:gae6e02f37f9fc03eb338b3114e0c0cae1"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes an image an 8 bit image. <a href="group___f_h5_i_m.html#gae6e02f37f9fc03eb338b3114e0c0cae1">More...</a><br /></td></tr>
<tr class="separator:gae6e02f37f9fc03eb338b3114e0c0cae1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc84c2ff04cf1b1d2217fb4d510a9908"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gadc84c2ff04cf1b1d2217fb4d510a9908">h5imread_image_f</a> (loc_id, dset_name, buf, errcode)</td></tr>
<tr class="memdesc:gadc84c2ff04cf1b1d2217fb4d510a9908"><td class="mdescLeft"> </td><td class="mdescRight">Reads image data from disk. <a href="group___f_h5_i_m.html#gadc84c2ff04cf1b1d2217fb4d510a9908">More...</a><br /></td></tr>
<tr class="separator:gadc84c2ff04cf1b1d2217fb4d510a9908"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafc0ae90dc14f6a921b44a87f4e4a79a3"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gafc0ae90dc14f6a921b44a87f4e4a79a3">h5immake_image_24bit_f</a> (loc_id, dset_name, width, height, il, buf, errcode)</td></tr>
<tr class="memdesc:gafc0ae90dc14f6a921b44a87f4e4a79a3"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes an image a 24 bit image. <a href="group___f_h5_i_m.html#gafc0ae90dc14f6a921b44a87f4e4a79a3">More...</a><br /></td></tr>
<tr class="separator:gafc0ae90dc14f6a921b44a87f4e4a79a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb023e62fc90e72c5eb44fc82e0ab0b8"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gabb023e62fc90e72c5eb44fc82e0ab0b8">h5imget_image_info_f</a> (loc_id, dset_name, width, height, planes, interlace, npals, errcode)</td></tr>
<tr class="memdesc:gabb023e62fc90e72c5eb44fc82e0ab0b8"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). <a href="group___f_h5_i_m.html#gabb023e62fc90e72c5eb44fc82e0ab0b8">More...</a><br /></td></tr>
<tr class="separator:gabb023e62fc90e72c5eb44fc82e0ab0b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ac99ef08aeefb0e8c077d0c44cf4671"><td class="memItemLeft" align="right" valign="top">integer function </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#ga0ac99ef08aeefb0e8c077d0c44cf4671">h5imis_image_f</a> (loc_id, dset_name)</td></tr>
<tr class="memdesc:ga0ac99ef08aeefb0e8c077d0c44cf4671"><td class="mdescLeft"> </td><td class="mdescRight">Inquires if a dataset is an image. <a href="group___f_h5_i_m.html#ga0ac99ef08aeefb0e8c077d0c44cf4671">More...</a><br /></td></tr>
<tr class="separator:ga0ac99ef08aeefb0e8c077d0c44cf4671"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga551ab8b6502efd74efeca6b0dfa0ba2f"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#ga551ab8b6502efd74efeca6b0dfa0ba2f">h5immake_palette_f</a> (loc_id, pal_name, pal_dims, pal_data, errcode)</td></tr>
<tr class="memdesc:ga551ab8b6502efd74efeca6b0dfa0ba2f"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes a palette. <a href="group___f_h5_i_m.html#ga551ab8b6502efd74efeca6b0dfa0ba2f">More...</a><br /></td></tr>
<tr class="separator:ga551ab8b6502efd74efeca6b0dfa0ba2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga99fe1f91ad807d304418cafdf73b4e17"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#ga99fe1f91ad807d304418cafdf73b4e17">h5imlink_palette_f</a> (loc_id, image_name, pal_name, errcode)</td></tr>
<tr class="memdesc:ga99fe1f91ad807d304418cafdf73b4e17"><td class="mdescLeft"> </td><td class="mdescRight">This function attaches a palette to an existing image dataset. <a href="group___f_h5_i_m.html#ga99fe1f91ad807d304418cafdf73b4e17">More...</a><br /></td></tr>
<tr class="separator:ga99fe1f91ad807d304418cafdf73b4e17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad343bf9c5c10bd7e9d30cd06aa92a4cb"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gad343bf9c5c10bd7e9d30cd06aa92a4cb">h5imunlink_palette_f</a> (loc_id, image_name, pal_name, errcode)</td></tr>
<tr class="memdesc:gad343bf9c5c10bd7e9d30cd06aa92a4cb"><td class="mdescLeft"> </td><td class="mdescRight">This function detaches a palette to an existing image dataset. <a href="group___f_h5_i_m.html#gad343bf9c5c10bd7e9d30cd06aa92a4cb">More...</a><br /></td></tr>
<tr class="separator:gad343bf9c5c10bd7e9d30cd06aa92a4cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga223f22d09e3ca3acb0fd08ae4dc52812"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#ga223f22d09e3ca3acb0fd08ae4dc52812">h5imget_npalettes_f</a> (loc_id, image_name, npals, errcode)</td></tr>
<tr class="memdesc:ga223f22d09e3ca3acb0fd08ae4dc52812"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of palettes associated to an image. <a href="group___f_h5_i_m.html#ga223f22d09e3ca3acb0fd08ae4dc52812">More...</a><br /></td></tr>
<tr class="separator:ga223f22d09e3ca3acb0fd08ae4dc52812"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaffe026b4c50cb705c95498dd95e006b2"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gaffe026b4c50cb705c95498dd95e006b2">h5imget_palette_info_f</a> (loc_id, image_name, pal_number, pal_dims, errcode)</td></tr>
<tr class="memdesc:gaffe026b4c50cb705c95498dd95e006b2"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about a palette dataset (dimensions). <a href="group___f_h5_i_m.html#gaffe026b4c50cb705c95498dd95e006b2">More...</a><br /></td></tr>
<tr class="separator:gaffe026b4c50cb705c95498dd95e006b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad2d0e40292aecffe5de6c23626a6f691"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#gad2d0e40292aecffe5de6c23626a6f691">h5imget_palette_f</a> (loc_id, image_name, pal_number, pal_data, errcode)</td></tr>
<tr class="memdesc:gad2d0e40292aecffe5de6c23626a6f691"><td class="mdescLeft"> </td><td class="mdescRight">Gets the palette dataset. <a href="group___f_h5_i_m.html#gad2d0e40292aecffe5de6c23626a6f691">More...</a><br /></td></tr>
<tr class="separator:gad2d0e40292aecffe5de6c23626a6f691"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga784eb1a01103275844508194d0464376"><td class="memItemLeft" align="right" valign="top">integer function </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_i_m.html#ga784eb1a01103275844508194d0464376">h5imis_palette_f</a> (loc_id, dset_name)</td></tr>
<tr class="memdesc:ga784eb1a01103275844508194d0464376"><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. <a href="group___f_h5_i_m.html#ga784eb1a01103275844508194d0464376">More...</a><br /></td></tr>
<tr class="separator:ga784eb1a01103275844508194d0464376"><td class="memSeparator" colspan="2"> </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 H5IM. </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="namespaceh5im.html">h5im</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.9.1 </li>
</ul>
</div>
</body>
</html>
|
