mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9038e9f7cd7df6c71b8035cc765f268600a974
hdf5/develop/group___h5_i_m.html
T
byrnHDF ea9038e9f7 deploy: 780f6e40de
2026-09-02 01:23:41 +00:00

752 lines
50 KiB
HTML
Raw Blame History

<!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: HDF5 Images API (H5IM)</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">&#160;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&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;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&#160;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('group___h5_i_m.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">HDF5 Images API (H5IM) </div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p><em>Creating and manipulating HDF5 datasets intended to be interpreted as images (H5IM)</em></p>
<p>The specification for the Images API is presented in another document: <a class="el" href="_i_m_g.html" title="HDF5 Image and Palette Specification Version 1.2">HDF5 Image and Palette Specification Version 1.2</a> This version of the API is primarily concerned with two dimensional raster data similar to HDF4 Raster Images. The HDF5 Images API uses the <a class="el" href="group___h5_l_t.html" title="HDF5 Lite APIs (H5LT,H5LD)">HDF5 Lite APIs (H5LT,H5LD)</a>.</p>
<dl class="section note"><dt>Note</dt><dd><b>Programming hints:</b> </dd>
<dd>
To use any of these functions or subroutines, you must first include the relevant include file (C) or module (Fortran) in your application. </dd>
<dd>
The following line includes the HDF5 Images package, H5IM, in C applications: <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;hdf5_hl.h&quot;</span> </div>
</div><!-- fragment --> </dd>
<dd>
This line includes the H5IM module in Fortran applications: <div class="fragment"><div class="line">use <a class="code hl_namespace" href="namespaceh5im.html">h5im</a> </div>
<div class="ttc" id="anamespaceh5im_html"><div class="ttname"><a href="namespaceh5im.html">h5im</a></div><div class="ttdoc">This module contains Fortran interfaces for H5IM.</div><div class="ttdef"><b>Definition</b> H5IMff.F90:35</div></div>
</div><!-- fragment --></dd></dl>
<ul>
<li><a class="el" href="#gad1d25d015457bfa2f00faf0952cc1f75" title="H5IMget_image_info">H5IMget_image_info</a> <br />
Gets information about an image dataset (dimensions, interlace mode and number of associated palettes).</li>
<li><a class="el" href="#ga8644c36dbe768ea02d1ced695ab6b6b0" title="H5IMget_npalettes">H5IMget_npalettes</a> <br />
Gets the number of palettes associated to an image.</li>
<li><a class="el" href="#ga89882863675a88899c327026237aecef" title="H5IMget_palette">H5IMget_palette</a> <br />
Gets the palette dataset.</li>
<li><a class="el" href="#ga2c669d6a99cd1f3ea0d5005cd106f5dc" title="H5IMget_palette_info">H5IMget_palette_info</a> <br />
Gets information about a palette dataset (dimensions).</li>
<li><a class="el" href="#gadd8c46c44a11fa36116a0b7314f248a8" title="H5IMis_image">H5IMis_image</a> <br />
Inquires if a dataset is an image</li>
<li><a class="el" href="#ga01d20431a40121ca9be11b6cb4b629a8" title="H5IMis_palette">H5IMis_palette</a> <br />
Inquires if a dataset is a palette.</li>
<li><a class="el" href="#gaa653878da63058bc7435f5ae7da8dc94" title="H5IMlink_palette">H5IMlink_palette</a> <br />
Attaches a palette to an image.</li>
<li><a class="el" href="#gaed2cb8f411b58e6e48d596bba1d3b59b" title="H5IMmake_image_8bit">H5IMmake_image_8bit</a> <br />
Creates and writes an image.</li>
<li><a class="el" href="#ga151b78eea0bff9872af78f950c93c862" title="H5IMmake_image_24bit">H5IMmake_image_24bit</a> <br />
Creates and writes a true color image.</li>
<li><a class="el" href="#gad6811d80238b25851cbde0475537b7d3" title="H5IMmake_palette">H5IMmake_palette</a> <br />
Creates and writes a palette.</li>
<li><a class="el" href="#gaec44462e614bb5b93d5776ca27491488" title="H5IMread_image">H5IMread_image</a> <br />
Reads image data from disk.</li>
<li><a class="el" href="#ga03f849a73219b982d8dbae2f1cbb7b7b" title="H5IMunlink_palette">H5IMunlink_palette</a> <br />
Detaches a palette from an image. </li>
</ul>
</div><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</h2></td></tr>
<tr class="memitem:gad1d25d015457bfa2f00faf0952cc1f75" id="r_gad1d25d015457bfa2f00faf0952cc1f75"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gad1d25d015457bfa2f00faf0952cc1f75">H5IMget_image_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *width, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *height, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *planes, char *interlace, <a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> *npals)</td></tr>
<tr class="memdesc:gad1d25d015457bfa2f00faf0952cc1f75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). <br /></td></tr>
<tr class="memitem:ga8644c36dbe768ea02d1ced695ab6b6b0" id="r_ga8644c36dbe768ea02d1ced695ab6b6b0"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga8644c36dbe768ea02d1ced695ab6b6b0">H5IMget_npalettes</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *image_name, <a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> *npals)</td></tr>
<tr class="memdesc:ga8644c36dbe768ea02d1ced695ab6b6b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of palettes associated to an image. <br /></td></tr>
<tr class="memitem:ga89882863675a88899c327026237aecef" id="r_ga89882863675a88899c327026237aecef"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga89882863675a88899c327026237aecef">H5IMget_palette</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *image_name, int pal_number, unsigned char *pal_data)</td></tr>
<tr class="memdesc:ga89882863675a88899c327026237aecef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the palette dataset. <br /></td></tr>
<tr class="memitem:ga2c669d6a99cd1f3ea0d5005cd106f5dc" id="r_ga2c669d6a99cd1f3ea0d5005cd106f5dc"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga2c669d6a99cd1f3ea0d5005cd106f5dc">H5IMget_palette_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *image_name, int pal_number, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *pal_dims)</td></tr>
<tr class="memdesc:ga2c669d6a99cd1f3ea0d5005cd106f5dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets information about a palette dataset (dimensions). <br /></td></tr>
<tr class="memitem:gadd8c46c44a11fa36116a0b7314f248a8" id="r_gadd8c46c44a11fa36116a0b7314f248a8"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gadd8c46c44a11fa36116a0b7314f248a8">H5IMis_image</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name)</td></tr>
<tr class="memdesc:gadd8c46c44a11fa36116a0b7314f248a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inquires if a dataset is an image. <br /></td></tr>
<tr class="memitem:ga01d20431a40121ca9be11b6cb4b629a8" id="r_ga01d20431a40121ca9be11b6cb4b629a8"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga01d20431a40121ca9be11b6cb4b629a8">H5IMis_palette</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name)</td></tr>
<tr class="memdesc:ga01d20431a40121ca9be11b6cb4b629a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inquires if a dataset is a palette. <br /></td></tr>
<tr class="memitem:gaa653878da63058bc7435f5ae7da8dc94" id="r_gaa653878da63058bc7435f5ae7da8dc94"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gaa653878da63058bc7435f5ae7da8dc94">H5IMlink_palette</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *image_name, const char *pal_name)</td></tr>
<tr class="memdesc:gaa653878da63058bc7435f5ae7da8dc94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches a palette to an image. <br /></td></tr>
<tr class="memitem:ga151b78eea0bff9872af78f950c93c862" id="r_ga151b78eea0bff9872af78f950c93c862"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga151b78eea0bff9872af78f950c93c862">H5IMmake_image_24bit</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> width, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> height, const char *interlace, const unsigned char *buffer)</td></tr>
<tr class="memdesc:ga151b78eea0bff9872af78f950c93c862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and writes a true color image. <br /></td></tr>
<tr class="memitem:gaed2cb8f411b58e6e48d596bba1d3b59b" id="r_gaed2cb8f411b58e6e48d596bba1d3b59b"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gaed2cb8f411b58e6e48d596bba1d3b59b">H5IMmake_image_8bit</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> width, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> height, const unsigned char *buffer)</td></tr>
<tr class="memdesc:gaed2cb8f411b58e6e48d596bba1d3b59b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and writes an image. <br /></td></tr>
<tr class="memitem:gad6811d80238b25851cbde0475537b7d3" id="r_gad6811d80238b25851cbde0475537b7d3"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gad6811d80238b25851cbde0475537b7d3">H5IMmake_palette</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *pal_name, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *pal_dims, const unsigned char *pal_data)</td></tr>
<tr class="memdesc:gad6811d80238b25851cbde0475537b7d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and writes a palette. <br /></td></tr>
<tr class="memitem:gaec44462e614bb5b93d5776ca27491488" id="r_gaec44462e614bb5b93d5776ca27491488"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#gaec44462e614bb5b93d5776ca27491488">H5IMread_image</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *dset_name, unsigned char *buffer)</td></tr>
<tr class="memdesc:gaec44462e614bb5b93d5776ca27491488"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads image data from disk. <br /></td></tr>
<tr class="memitem:ga03f849a73219b982d8dbae2f1cbb7b7b" id="r_ga03f849a73219b982d8dbae2f1cbb7b7b"><td class="memItemLeft">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight"><a class="el" href="#ga03f849a73219b982d8dbae2f1cbb7b7b">H5IMunlink_palette</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *image_name, const char *pal_name)</td></tr>
<tr class="memdesc:ga03f849a73219b982d8dbae2f1cbb7b7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detaches a palette from an image. <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="gad1d25d015457bfa2f00faf0952cc1f75" name="gad1d25d015457bfa2f00faf0952cc1f75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad1d25d015457bfa2f00faf0952cc1f75">&#9670;&#160;</a></span>H5IMget_image_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMget_image_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dset_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>height</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>planes</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>interlace</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> *</td> <td class="paramname"><span class="paramname"><em>npals</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">width</td><td>The width of the image </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">height</td><td>The height of the image </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">planes</td><td>The number of color planes of the image </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">interlace</td><td>The interlace mode of the image </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">npals</td><td>The number of palettes associated to the image</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gad1d25d015457bfa2f00faf0952cc1f75" title="Gets information about an image dataset (dimensions, interlace mode and number of associated palettes...">H5IMget_image_info()</a> gets information about an image named <code class="param">dset_name</code> attached to the file or group specified by the identifier <code class="param">loc_id</code>. </p>
</div>
</div>
<a id="ga8644c36dbe768ea02d1ced695ab6b6b0" name="ga8644c36dbe768ea02d1ced695ab6b6b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8644c36dbe768ea02d1ced695ab6b6b0">&#9670;&#160;</a></span>H5IMget_npalettes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMget_npalettes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>image_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> *</td> <td class="paramname"><span class="paramname"><em>npals</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of palettes associated to an image. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">image_name</td><td>The name of the image dataset </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">npals</td><td>The number of palettes</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga8644c36dbe768ea02d1ced695ab6b6b0" title="Gets the number of palettes associated to an image.">H5IMget_npalettes()</a> gets the number of palettes associated to an image specified by <code class="param">image_name</code>. </p>
</div>
</div>
<a id="ga89882863675a88899c327026237aecef" name="ga89882863675a88899c327026237aecef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89882863675a88899c327026237aecef">&#9670;&#160;</a></span>H5IMget_palette()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMget_palette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>image_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>pal_number</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *</td> <td class="paramname"><span class="paramname"><em>pal_data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the palette dataset. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">image_name</td><td>The name of the image dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_number</td><td>The zero based index that identifies the palette </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pal_data</td><td>The palette dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga89882863675a88899c327026237aecef" title="Gets the palette dataset.">H5IMget_palette()</a> gets the palette dataset identified by <code class="param">pal_number</code> (a zero based index) associated to an image specified by <code class="param">image_name</code>. </p>
</div>
</div>
<a id="ga2c669d6a99cd1f3ea0d5005cd106f5dc" name="ga2c669d6a99cd1f3ea0d5005cd106f5dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c669d6a99cd1f3ea0d5005cd106f5dc">&#9670;&#160;</a></span>H5IMget_palette_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMget_palette_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>image_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>pal_number</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>pal_dims</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets information about a palette dataset (dimensions). </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">image_name</td><td>The name of the image dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_number</td><td>The zero based index that identifies the palette </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pal_dims</td><td>The dimensions of the palette dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga2c669d6a99cd1f3ea0d5005cd106f5dc" title="Gets information about a palette dataset (dimensions).">H5IMget_palette_info()</a> gets the dimensions of the palette dataset identified by <code class="param">pal_number</code> (a zero based index) associated to an image specified by <code class="param">image_name</code>. </p>
</div>
</div>
<a id="gadd8c46c44a11fa36116a0b7314f248a8" name="gadd8c46c44a11fa36116a0b7314f248a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd8c46c44a11fa36116a0b7314f248a8">&#9670;&#160;</a></span>H5IMis_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMis_image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dset_name</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inquires if a dataset is an image. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#gadd8c46c44a11fa36116a0b7314f248a8" title="Inquires if a dataset is an image.">H5IMis_image()</a> inquires if a dataset named <code class="param">dset_name</code>, attached to the file or group specified by the identifier <code class="param">loc_id</code>, is an image based on the HDF5 Image and Palette Specification. </p>
</div>
</div>
<a id="ga01d20431a40121ca9be11b6cb4b629a8" name="ga01d20431a40121ca9be11b6cb4b629a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga01d20431a40121ca9be11b6cb4b629a8">&#9670;&#160;</a></span>H5IMis_palette()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMis_palette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dset_name</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inquires if a dataset is a palette. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#ga01d20431a40121ca9be11b6cb4b629a8" title="Inquires if a dataset is a palette.">H5IMis_palette()</a> inquires if a dataset named <code class="param">dset_name</code>, attached to the file or group specified by the identifier <code class="param">loc_id</code>, is a palette based on the HDF5 Image and Palette Specification. </p>
</div>
</div>
<a id="gaa653878da63058bc7435f5ae7da8dc94" name="gaa653878da63058bc7435f5ae7da8dc94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa653878da63058bc7435f5ae7da8dc94">&#9670;&#160;</a></span>H5IMlink_palette()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMlink_palette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>image_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>pal_name</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches a palette to an image. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">image_name</td><td>The name of the dataset to attach the palette to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_name</td><td>The name of the palette</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaa653878da63058bc7435f5ae7da8dc94" title="Attaches a palette to an image.">H5IMlink_palette()</a> attaches a palette named <code class="param">pal_name</code> to an image specified by <code class="param">image_name</code>. The image dataset may or not already have an attached palette. If it has, the array of palette references is extended to hold the reference to the new palette. </p>
</div>
</div>
<a id="ga151b78eea0bff9872af78f950c93c862" name="ga151b78eea0bff9872af78f950c93c862"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga151b78eea0bff9872af78f950c93c862">&#9670;&#160;</a></span>H5IMmake_image_24bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMmake_image_24bit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dset_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>height</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>interlace</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and writes a true color image. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The width of the image </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The height of the image </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">interlace</td><td>String defining the interlace mode </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Buffer with data to be written to the dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga151b78eea0bff9872af78f950c93c862" title="Creates and writes a true color image.">H5IMmake_image_24bit()</a> creates and writes a dataset named <code class="param">dset_name</code> attached to the file or group specified by the identifier <code class="param">loc_id</code>. This function defines a true color image conforming to the HDF5 Image and Palette specification. The function assumes that the image data is of the type <a class="el" href="group___p_d_t_n_a_t.html#ga39cadf50f1701a2af3afa86eba3c7cbd">H5T_NATIVE_UCHAR</a>.</p>
<p>A true color image is an image where the pixel storage contains several color planes. In a 24 bit RGB color model, these planes are red, green and blue. In a true color image the stream of bytes can be stored in several different ways, thus defining the interlace (or interleaving) mode. The 2 most used types of interlace mode are interlace by pixel and interlace by plane. In the 24 bit RGB color model example, interlace by plane means all the red components for the entire dataset are stored first, followed by all the green components, and then by all the blue components. Interlace by pixel in this example means that for each pixel the sequence red, green, blue is defined. In this function, the interlace mode is defined in the parameter <code class="param">interlace</code>, a string that can have the values INTERLACE_PIXEL or INTERLACE_PLANE. </p>
</div>
</div>
<a id="gaed2cb8f411b58e6e48d596bba1d3b59b" name="gaed2cb8f411b58e6e48d596bba1d3b59b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed2cb8f411b58e6e48d596bba1d3b59b">&#9670;&#160;</a></span>H5IMmake_image_8bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMmake_image_8bit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dset_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>height</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and writes an image. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The width of the image </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The height of the image </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Buffer with data to be written to the dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaed2cb8f411b58e6e48d596bba1d3b59b" title="Creates and writes an image.">H5IMmake_image_8bit()</a> creates and writes a dataset named <code class="param">dset_name</code> attached to the file or group specified by the identifier <code class="param">loc_id</code>. Attributes conforming to the HDF5 Image and Palette specification for an indexed image are attached to the dataset, thus identifying it as an image. The image data is of the type <a class="el" href="group___p_d_t_n_a_t.html#ga39cadf50f1701a2af3afa86eba3c7cbd">H5T_NATIVE_UCHAR</a>. An indexed image is an image in which each each pixel information storage is an index to a table palette. </p>
</div>
</div>
<a id="gad6811d80238b25851cbde0475537b7d3" name="gad6811d80238b25851cbde0475537b7d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6811d80238b25851cbde0475537b7d3">&#9670;&#160;</a></span>H5IMmake_palette()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMmake_palette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>pal_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>pal_dims</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>pal_data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and writes a palette. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_name</td><td>The name of the palette </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_dims</td><td>An array of the size of the palette dimensions </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_data</td><td>Buffer with data to be written to the dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gad6811d80238b25851cbde0475537b7d3" title="Creates and writes a palette.">H5IMmake_palette()</a> creates and writes a dataset named <code class="param">pal_name</code>. Attributes conforming to the HDF5 Image and Palette specification are attached to the dataset, thus identifying it as a palette. The palette data is of the type <a class="el" href="group___p_d_t_n_a_t.html#ga39cadf50f1701a2af3afa86eba3c7cbd">H5T_NATIVE_UCHAR</a>. </p>
</div>
</div>
<a id="gaec44462e614bb5b93d5776ca27491488" name="gaec44462e614bb5b93d5776ca27491488"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec44462e614bb5b93d5776ca27491488">&#9670;&#160;</a></span>H5IMread_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMread_image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dset_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads image data from disk. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dset_name</td><td>The name of the dataset to create </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Buffer with data to store the image</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaec44462e614bb5b93d5776ca27491488" title="Reads image data from disk.">H5IMread_image()</a> reads a dataset named <code class="param">dset_name</code> attached to the file or group specified by the identifier <code class="param">loc_id</code>. </p>
</div>
</div>
<a id="ga03f849a73219b982d8dbae2f1cbb7b7b" name="ga03f849a73219b982d8dbae2f1cbb7b7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03f849a73219b982d8dbae2f1cbb7b7b">&#9670;&#160;</a></span>H5IMunlink_palette()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5HL_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5IMunlink_palette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>image_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>pal_name</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Detaches a palette from an image. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">image_name</td><td>The name of the image dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pal_name</td><td>The name of the palette</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga03f849a73219b982d8dbae2f1cbb7b7b" title="Detaches a palette from an image.">H5IMunlink_palette()</a> detaches a palette from an image specified by <code class="param">image_name</code>. </p>
</div>
</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="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>
Reference in New Issue View Git Blame Copy Permalink