diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
| commit | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch) | |
| tree | 30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/group___f_h5_i_m.html | |
| parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
| download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 | |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/group___f_h5_i_m.html')
| -rw-r--r-- | develop/group___f_h5_i_m.html | 844 |
1 files changed, 844 insertions, 0 deletions
diff --git a/develop/group___f_h5_i_m.html b/develop/group___f_h5_i_m.html new file mode 100644 index 0000000..3813c39 --- /dev/null +++ b/develop/group___f_h5_i_m.html @@ -0,0 +1,844 @@ +<!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: Fortran High Level Images (H5IM) Interface</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.ef39882</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('group___f_h5_i_m.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">Fortran High Level Images (H5IM) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_i_m.html">HDF5 Images API (H5IM)</a>, C-HL API</dd> +<dd> +<a class="el" href="_h5_i_m__u_g.html">The HDF5 High Level Images</a>, User Guide </dd></dl> +<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> +<h2 class="groupheader">Function/Subroutine Documentation</h2> +<a id="gabb023e62fc90e72c5eb44fc82e0ab0b8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabb023e62fc90e72c5eb44fc82e0ab0b8">◆ </a></span>h5imget_image_info_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imget_image_info_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>width</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>height</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>planes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(inout) </td> + <td class="paramname"><em>interlace</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>npals</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset. </td></tr> + <tr><td class="paramname">width</td><td>The width of the image. </td></tr> + <tr><td class="paramname">height</td><td>The height of the image. </td></tr> + <tr><td class="paramname">planes</td><td>The number of color planes of the image. </td></tr> + <tr><td class="paramname">interlace</td><td>The interlace mode of the image. </td></tr> + <tr><td class="paramname">npals</td><td>The number of palettes associated to the image. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#ga2ab560392105bd196183392c5294022b">H5IMget_image_info()</a> </p> + +</div> +</div> +<a id="ga223f22d09e3ca3acb0fd08ae4dc52812"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga223f22d09e3ca3acb0fd08ae4dc52812">◆ </a></span>h5imget_npalettes_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imget_npalettes_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(inout) </td> + <td class="paramname"><em>npals</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets the number of palettes associated to an image. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">image_name</td><td>The name of the image dataset. </td></tr> + <tr><td class="paramname">npals</td><td>The number of palettes. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#ga9142d01f6eb4d370b1616abecc828107">H5IMget_npalettes()</a> </p> + +</div> +</div> +<a id="gad2d0e40292aecffe5de6c23626a6f691"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad2d0e40292aecffe5de6c23626a6f691">◆ </a></span>h5imget_palette_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imget_palette_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>pal_number</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, dimension(*), intent(inout) </td> + <td class="paramname"><em>pal_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets the palette dataset. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">image_name</td><td>The name of the image dataset. </td></tr> + <tr><td class="paramname">pal_number</td><td>The zero based index that identifies the palette. </td></tr> + <tr><td class="paramname">pal_data</td><td>The palette dataset. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#gac58986e771803a049c4fc447bbebe218">H5IMget_palette_info()</a> </p> + +</div> +</div> +<a id="gaffe026b4c50cb705c95498dd95e006b2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaffe026b4c50cb705c95498dd95e006b2">◆ </a></span>h5imget_palette_info_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imget_palette_info_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>pal_number</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), dimension(*), intent(inout) </td> + <td class="paramname"><em>pal_dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets information about a palette dataset (dimensions). </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">image_name</td><td>The name of the image dataset. </td></tr> + <tr><td class="paramname">pal_number</td><td>The zero based index that identifies the palette. </td></tr> + <tr><td class="paramname">pal_dims</td><td>The dimensions of the palette dataset. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#gac58986e771803a049c4fc447bbebe218">H5IMget_palette_info()</a> </p> + +</div> +</div> +<a id="ga0ac99ef08aeefb0e8c077d0c44cf4671"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0ac99ef08aeefb0e8c077d0c44cf4671">◆ </a></span>h5imis_image_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer function h5im::h5imis_image_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Inquires if a dataset is an image. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#ga2732b9ac7075da22ff49396cec61a248">H5IMis_image()</a> </p> + +</div> +</div> +<a id="ga784eb1a01103275844508194d0464376"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga784eb1a01103275844508194d0464376">◆ </a></span>h5imis_palette_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">integer function h5im::h5imis_palette_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Inquires if a dataset is a palette. Returns zero (false), a positive (true) or a negative (failure) value. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#gaaddea3b7955ea7b22a9f00d49b918985">H5IMis_palette()</a> </p> + +</div> +</div> +<a id="ga99fe1f91ad807d304418cafdf73b4e17"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga99fe1f91ad807d304418cafdf73b4e17">◆ </a></span>h5imlink_palette_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imlink_palette_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>pal_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This function attaches a palette to an existing image dataset. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">image_name</td><td>The name of the dataset to attach the palette to. </td></tr> + <tr><td class="paramname">pal_name</td><td>The name of the palette. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#ga9b8f3d89fa9cca0821160e93c6bfbdf7">H5IMlink_palette()</a> </p> + +</div> +</div> +<a id="gafc0ae90dc14f6a921b44a87f4e4a79a3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafc0ae90dc14f6a921b44a87f4e4a79a3">◆ </a></span>h5immake_image_24bit_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5immake_image_24bit_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>width</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>height</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>il</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, dimension(*), intent(in) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates and writes an image a 24 bit image. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to create. </td></tr> + <tr><td class="paramname">width</td><td>The width of the image. </td></tr> + <tr><td class="paramname">height</td><td>The height of the image. </td></tr> + <tr><td class="paramname">il</td><td>String defining the interlace mode. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data to be written to the dataset. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#ga0b9dc08177df3ec180cbce17c41b5465">H5IMmake_image_24bit()</a> </p> + +</div> +</div> +<a id="gae6e02f37f9fc03eb338b3114e0c0cae1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae6e02f37f9fc03eb338b3114e0c0cae1">◆ </a></span>h5immake_image_8bit_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5immake_image_8bit_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>width</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), intent(in) </td> + <td class="paramname"><em>height</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, dimension(*), intent(in) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates and writes an image an 8 bit image. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to create. </td></tr> + <tr><td class="paramname">width</td><td>The width of the image. </td></tr> + <tr><td class="paramname">height</td><td>The height of the image </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data to be written to the dataset </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#gaee98bf669d32eafa212b2f0dadbdb8be">H5IMmake_image_8bit()</a> </p> + +</div> +</div> +<a id="ga551ab8b6502efd74efeca6b0dfa0ba2f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga551ab8b6502efd74efeca6b0dfa0ba2f">◆ </a></span>h5immake_palette_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5immake_palette_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>pal_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>), dimension(*), intent(in) </td> + <td class="paramname"><em>pal_dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, dimension(*), intent(in) </td> + <td class="paramname"><em>pal_data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates and writes a palette. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">pal_name</td><td>The name of the palette. </td></tr> + <tr><td class="paramname">pal_dims</td><td>An array of the size of the palette dimensions. </td></tr> + <tr><td class="paramname">pal_data</td><td>Buffer with data to be written to the dataset. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#ga3d6d279bfa9c37d2f816bb5c3ac9aa9b">H5IMmake_palette()</a> </p> + +</div> +</div> +<a id="gadc84c2ff04cf1b1d2217fb4d510a9908"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadc84c2ff04cf1b1d2217fb4d510a9908">◆ </a></span>h5imread_image_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imread_image_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, dimension(*), intent(inout) </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads image data from disk. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">dset_name</td><td>The name of the dataset to create. </td></tr> + <tr><td class="paramname">buf</td><td>Buffer with data to store the image. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#gac92e1c8905ca6739a645ca59d41fc211">H5IMread_image()</a> </p> + +</div> +</div> +<a id="gad343bf9c5c10bd7e9d30cd06aa92a4cb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad343bf9c5c10bd7e9d30cd06aa92a4cb">◆ </a></span>h5imunlink_palette_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5im::h5imunlink_palette_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>pal_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>This function detaches a palette to an existing image dataset. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr> + <tr><td class="paramname">image_name</td><td>The name of the image dataset. </td></tr> + <tr><td class="paramname">pal_name</td><td>The name of the palette. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_i_m.html#gac23e207b116f5bf5071284ee2095687f">H5IMunlink_palette()</a> </p> + +</div> +</div> +</div><!-- contents --> +</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.9.1 </li> + </ul> +</div> +</body> +</html> |