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___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___h5_i_m.html')
| -rw-r--r-- | develop/group___h5_i_m.html | 834 |
1 files changed, 834 insertions, 0 deletions
diff --git a/develop/group___h5_i_m.html b/develop/group___h5_i_m.html new file mode 100644 index 0000000..4dac045 --- /dev/null +++ b/develop/group___h5_i_m.html @@ -0,0 +1,834 @@ +<!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: 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="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___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</a> </div> + <div class="headertitle"> +<div class="title">HDF5 Images API (H5IM)</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<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">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">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 "hdf5_hl.h"</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" 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="group___h5_i_m.html#ga2ab560392105bd196183392c5294022b">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="group___h5_i_m.html#ga9142d01f6eb4d370b1616abecc828107">H5IMget_npalettes</a> <br /> + Gets the number of palettes associated to an image.</li> +<li><a class="el" href="group___h5_i_m.html#gada001046e17af3023520ccfd6b5115dc">H5IMget_palette</a> <br /> + Gets the palette dataset.</li> +<li><a class="el" href="group___h5_i_m.html#gac58986e771803a049c4fc447bbebe218">H5IMget_palette_info</a> <br /> + Gets information about a palette dataset (dimensions).</li> +<li><a class="el" href="group___h5_i_m.html#ga2732b9ac7075da22ff49396cec61a248">H5IMis_image</a> <br /> + Inquires if a dataset is an image</li> +<li><a class="el" href="group___h5_i_m.html#gaaddea3b7955ea7b22a9f00d49b918985">H5IMis_palette</a> <br /> + Inquires if a dataset is a palette.</li> +<li><a class="el" href="group___h5_i_m.html#ga9b8f3d89fa9cca0821160e93c6bfbdf7">H5IMlink_palette</a> <br /> + Attaches a palette to an image.</li> +<li><a class="el" href="group___h5_i_m.html#gaee98bf669d32eafa212b2f0dadbdb8be">H5IMmake_image_8bit</a> <br /> + Creates and writes an image.</li> +<li><a class="el" href="group___h5_i_m.html#ga0b9dc08177df3ec180cbce17c41b5465">H5IMmake_image_24bit</a> <br /> + Creates and writes a true color image.</li> +<li><a class="el" href="group___h5_i_m.html#ga3d6d279bfa9c37d2f816bb5c3ac9aa9b">H5IMmake_palette</a> <br /> + Creates and writes a palette.</li> +<li><a class="el" href="group___h5_i_m.html#gac92e1c8905ca6739a645ca59d41fc211">H5IMread_image</a> <br /> + Reads image data from disk.</li> +<li><a class="el" href="group___h5_i_m.html#gac23e207b116f5bf5071284ee2095687f">H5IMunlink_palette</a> <br /> + Detaches a palette from an image. </li> +</ul> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gaee98bf669d32eafa212b2f0dadbdb8be"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#gaee98bf669d32eafa212b2f0dadbdb8be">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:gaee98bf669d32eafa212b2f0dadbdb8be"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes an image. <a href="group___h5_i_m.html#gaee98bf669d32eafa212b2f0dadbdb8be">More...</a><br /></td></tr> +<tr class="separator:gaee98bf669d32eafa212b2f0dadbdb8be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0b9dc08177df3ec180cbce17c41b5465"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#ga0b9dc08177df3ec180cbce17c41b5465">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:ga0b9dc08177df3ec180cbce17c41b5465"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes a true color image. <a href="group___h5_i_m.html#ga0b9dc08177df3ec180cbce17c41b5465">More...</a><br /></td></tr> +<tr class="separator:ga0b9dc08177df3ec180cbce17c41b5465"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2ab560392105bd196183392c5294022b"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#ga2ab560392105bd196183392c5294022b">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:ga2ab560392105bd196183392c5294022b"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). <a href="group___h5_i_m.html#ga2ab560392105bd196183392c5294022b">More...</a><br /></td></tr> +<tr class="separator:ga2ab560392105bd196183392c5294022b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac92e1c8905ca6739a645ca59d41fc211"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#gac92e1c8905ca6739a645ca59d41fc211">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:gac92e1c8905ca6739a645ca59d41fc211"><td class="mdescLeft"> </td><td class="mdescRight">Reads image data from disk. <a href="group___h5_i_m.html#gac92e1c8905ca6739a645ca59d41fc211">More...</a><br /></td></tr> +<tr class="separator:gac92e1c8905ca6739a645ca59d41fc211"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3d6d279bfa9c37d2f816bb5c3ac9aa9b"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#ga3d6d279bfa9c37d2f816bb5c3ac9aa9b">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:ga3d6d279bfa9c37d2f816bb5c3ac9aa9b"><td class="mdescLeft"> </td><td class="mdescRight">Creates and writes a palette. <a href="group___h5_i_m.html#ga3d6d279bfa9c37d2f816bb5c3ac9aa9b">More...</a><br /></td></tr> +<tr class="separator:ga3d6d279bfa9c37d2f816bb5c3ac9aa9b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9b8f3d89fa9cca0821160e93c6bfbdf7"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#ga9b8f3d89fa9cca0821160e93c6bfbdf7">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:ga9b8f3d89fa9cca0821160e93c6bfbdf7"><td class="mdescLeft"> </td><td class="mdescRight">Attaches a palette to an image. <a href="group___h5_i_m.html#ga9b8f3d89fa9cca0821160e93c6bfbdf7">More...</a><br /></td></tr> +<tr class="separator:ga9b8f3d89fa9cca0821160e93c6bfbdf7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac23e207b116f5bf5071284ee2095687f"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#gac23e207b116f5bf5071284ee2095687f">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:gac23e207b116f5bf5071284ee2095687f"><td class="mdescLeft"> </td><td class="mdescRight">Detaches a palette from an image. <a href="group___h5_i_m.html#gac23e207b116f5bf5071284ee2095687f">More...</a><br /></td></tr> +<tr class="separator:gac23e207b116f5bf5071284ee2095687f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9142d01f6eb4d370b1616abecc828107"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#ga9142d01f6eb4d370b1616abecc828107">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:ga9142d01f6eb4d370b1616abecc828107"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of palettes associated to an image. <a href="group___h5_i_m.html#ga9142d01f6eb4d370b1616abecc828107">More...</a><br /></td></tr> +<tr class="separator:ga9142d01f6eb4d370b1616abecc828107"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac58986e771803a049c4fc447bbebe218"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#gac58986e771803a049c4fc447bbebe218">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:gac58986e771803a049c4fc447bbebe218"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about a palette dataset (dimensions). <a href="group___h5_i_m.html#gac58986e771803a049c4fc447bbebe218">More...</a><br /></td></tr> +<tr class="separator:gac58986e771803a049c4fc447bbebe218"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gada001046e17af3023520ccfd6b5115dc"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#gada001046e17af3023520ccfd6b5115dc">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:gada001046e17af3023520ccfd6b5115dc"><td class="mdescLeft"> </td><td class="mdescRight">Gets the palette dataset. <a href="group___h5_i_m.html#gada001046e17af3023520ccfd6b5115dc">More...</a><br /></td></tr> +<tr class="separator:gada001046e17af3023520ccfd6b5115dc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2732b9ac7075da22ff49396cec61a248"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#ga2732b9ac7075da22ff49396cec61a248">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:ga2732b9ac7075da22ff49396cec61a248"><td class="mdescLeft"> </td><td class="mdescRight">Inquires if a dataset is an image. <a href="group___h5_i_m.html#ga2732b9ac7075da22ff49396cec61a248">More...</a><br /></td></tr> +<tr class="separator:ga2732b9ac7075da22ff49396cec61a248"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaddea3b7955ea7b22a9f00d49b918985"><td class="memItemLeft" align="right" valign="top">H5_HLDLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_i_m.html#gaaddea3b7955ea7b22a9f00d49b918985">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:gaaddea3b7955ea7b22a9f00d49b918985"><td class="mdescLeft"> </td><td class="mdescRight">Inquires if a dataset is a palette. <a href="group___h5_i_m.html#gaaddea3b7955ea7b22a9f00d49b918985">More...</a><br /></td></tr> +<tr class="separator:gaaddea3b7955ea7b22a9f00d49b918985"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="ga2ab560392105bd196183392c5294022b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2ab560392105bd196183392c5294022b">◆ </a></span>H5IMget_image_info()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em>, </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"><em>width</em>, </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"><em>height</em>, </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"><em>planes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>interlace</em>, </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"><em>npals</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> +<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="group___h5_i_m.html#ga2ab560392105bd196183392c5294022b" 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>dset_name</code> attached to the file or group specified by the identifier <code>loc_id</code>. </p> + +</div> +</div> +<a id="ga9142d01f6eb4d370b1616abecc828107"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9142d01f6eb4d370b1616abecc828107">◆ </a></span>H5IMget_npalettes()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>image_name</em>, </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"><em>npals</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> +<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="group___h5_i_m.html#ga9142d01f6eb4d370b1616abecc828107" 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>image_name</code>. </p> + +</div> +</div> +<a id="gada001046e17af3023520ccfd6b5115dc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gada001046e17af3023520ccfd6b5115dc">◆ </a></span>H5IMget_palette()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>pal_number</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned char * </td> + <td class="paramname"><em>pal_data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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="group___h5_i_m.html#gada001046e17af3023520ccfd6b5115dc" title="Gets the palette dataset.">H5IMget_palette()</a> gets the palette dataset identified by <code>pal_number</code> (a zero based index) associated to an image specified by <code>image_name</code>. </p> + +</div> +</div> +<a id="gac58986e771803a049c4fc447bbebe218"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac58986e771803a049c4fc447bbebe218">◆ </a></span>H5IMget_palette_info()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>pal_number</em>, </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"><em>pal_dims</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> +<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="group___h5_i_m.html#gac58986e771803a049c4fc447bbebe218" title="Gets information about a palette dataset (dimensions).">H5IMget_palette_info()</a> gets the dimensions of the palette dataset identified by <code>pal_number</code> (a zero based index) associated to an image specified by <code>image_name</code>. </p> + +</div> +</div> +<a id="ga2732b9ac7075da22ff49396cec61a248"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2732b9ac7075da22ff49396cec61a248">◆ </a></span>H5IMis_image()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </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> +<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="group___h5_i_m.html#ga2732b9ac7075da22ff49396cec61a248" title="Inquires if a dataset is an image.">H5IMis_image()</a> inquires if a dataset named <code>dset_name</code>, attached to the file or group specified by the identifier <code>loc_id</code>, is an image based on the HDF5 Image and Palette Specification. </p> + +</div> +</div> +<a id="gaaddea3b7955ea7b22a9f00d49b918985"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaddea3b7955ea7b22a9f00d49b918985">◆ </a></span>H5IMis_palette()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </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. </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="group___h5_i_m.html#gaaddea3b7955ea7b22a9f00d49b918985" title="Inquires if a dataset is a palette.">H5IMis_palette()</a> inquires if a dataset named <code>dset_name</code>, attached to the file or group specified by the identifier <code>loc_id</code>, is a palette based on the HDF5 Image and Palette Specification. </p> + +</div> +</div> +<a id="ga9b8f3d89fa9cca0821160e93c6bfbdf7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9b8f3d89fa9cca0821160e93c6bfbdf7">◆ </a></span>H5IMlink_palette()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>pal_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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="group___h5_i_m.html#ga9b8f3d89fa9cca0821160e93c6bfbdf7" title="Attaches a palette to an image.">H5IMlink_palette()</a> attaches a palette named <code>pal_name</code> to an image specified by <code>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="ga0b9dc08177df3ec180cbce17c41b5465"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0b9dc08177df3ec180cbce17c41b5465">◆ </a></span>H5IMmake_image_24bit()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em>, </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"><em>width</em>, </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"><em>height</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>interlace</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const unsigned char * </td> + <td class="paramname"><em>buffer</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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="group___h5_i_m.html#ga0b9dc08177df3ec180cbce17c41b5465" title="Creates and writes a true color image.">H5IMmake_image_24bit()</a> creates and writes a dataset named <code>dset_name</code> attached to the file or group specified by the identifier <code>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>interlace</code>, a string that can have the values INTERLACE_PIXEL or INTERLACE_PLANE. </p> + +</div> +</div> +<a id="gaee98bf669d32eafa212b2f0dadbdb8be"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaee98bf669d32eafa212b2f0dadbdb8be">◆ </a></span>H5IMmake_image_8bit()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em>, </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"><em>width</em>, </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"><em>height</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const unsigned char * </td> + <td class="paramname"><em>buffer</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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="group___h5_i_m.html#gaee98bf669d32eafa212b2f0dadbdb8be" title="Creates and writes an image.">H5IMmake_image_8bit()</a> creates and writes a dataset named <code>dset_name</code> attached to the file or group specified by the identifier <code>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="ga3d6d279bfa9c37d2f816bb5c3ac9aa9b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3d6d279bfa9c37d2f816bb5c3ac9aa9b">◆ </a></span>H5IMmake_palette()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>pal_name</em>, </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"><em>pal_dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const unsigned char * </td> + <td class="paramname"><em>pal_data</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> +<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="group___h5_i_m.html#ga3d6d279bfa9c37d2f816bb5c3ac9aa9b" title="Creates and writes a palette.">H5IMmake_palette()</a> creates and writes a dataset named <code>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="gac92e1c8905ca6739a645ca59d41fc211"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac92e1c8905ca6739a645ca59d41fc211">◆ </a></span>H5IMread_image()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>dset_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned char * </td> + <td class="paramname"><em>buffer</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> +<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="group___h5_i_m.html#gac92e1c8905ca6739a645ca59d41fc211" title="Reads image data from disk.">H5IMread_image()</a> reads a dataset named <code>dset_name</code> attached to the file or group specified by the identifier <code>loc_id</code>. </p> + +</div> +</div> +<a id="gac23e207b116f5bf5071284ee2095687f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac23e207b116f5bf5071284ee2095687f">◆ </a></span>H5IMunlink_palette()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5_HLDLL <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"><em>loc_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>image_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>pal_name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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="group___h5_i_m.html#gac23e207b116f5bf5071284ee2095687f" title="Detaches a palette from an image.">H5IMunlink_palette()</a> detaches a palette from an image specified by <code>image_name</code>. </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> |