2
0
mirror of https://github.com/boostorg/gil.git synced 2026-01-26 18:42:12 +00:00
Files
gil/develop/doc/html/histogram/overview.html
github-actions[bot] 2bcaf6ef0e deploy: 4fec872feb
2024-05-10 07:38:12 +00:00

124 lines
5.6 KiB
HTML

<!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/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Overview - Boost.GIL documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html'
};
</script>
<script type="text/javascript" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/searchtools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="Boost.GIL documentation" href="../index.html" />
<link rel="up" title="Histogram" href="index.html" />
<link rel="next" title="Create a histogram" href="create.html" />
<link rel="prev" title="Histogram" href="index.html" />
</head>
<body>
<div class="header">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
"header">
<tr>
<td valign="top" width="300">
<h3><a href="../index.html"><img
alt="C++ Boost" src="../_static/gil.png" border="0"></a></h3>
</td>
<td >
<h1 align="center"><a href="../index.html"></a></h1>
</td>
<td>
<div id="searchbox" style="display: none">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</td>
</tr>
</table>
</div>
<hr/>
<div class="content">
<div class="navbar" style="text-align:right;">
<a class="prev" title="Histogram" href="index.html"><img src="../_static/prev.png" alt="prev"/></a>
<a class="up" title="Histogram" href="index.html"><img src="../_static/up.png" alt="up"/></a>
<a class="next" title="Create a histogram" href="create.html"><img src="../_static/next.png" alt="next"/></a>
</div>
<section id="overview">
<h1>Overview</h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
<li><p><a class="reference internal" href="#tutorials" id="id2">Tutorials</a></p></li>
</ul>
</div>
<section id="description">
<h2><a class="toc-backref" href="#id1">Description</a></h2>
<p>The histogram class is built on top of std::unordered_map to keep it compatible with other
STL algorithms. It can support any number of axes (known at compile time i.e. during class
instantiation). Suitable conversion routines from GIL image constructs to the histogram bin
key are shipped with the class itself.</p>
</section>
<section id="tutorials">
<h2><a class="toc-backref" href="#id2">Tutorials</a></h2>
<dl class="simple">
<dt>The following flow is recommended:</dt><dd><ol class="arabic simple">
<li><p><a class="reference internal" href="create.html#create-histogram"><span class="std std-ref">Create a histogram</span></a></p></li>
<li><p><a class="reference internal" href="fill.html#fill-it"><span class="std std-ref">Fill histogram</span></a></p></li>
<li><p><a class="reference internal" href="subhistogram.html#sub-histogram"><span class="std std-ref">Making a sub-histogram</span></a></p></li>
<li><p><a class="reference internal" href="cumulative.html#cumulative-histogram"><span class="std std-ref">Making a cumulative histogram</span></a></p></li>
<li><p><a class="reference internal" href="stl_compatibility.html#stl-compatibility"><span class="std std-ref">STL compatibility</span></a></p></li>
<li><p><a class="reference internal" href="extend.html#extend-support"><span class="std std-ref">Extending the class</span></a></p></li>
<li><p><a class="reference internal" href="limitations.html#limitations"><span class="std std-ref">Limitations</span></a></p></li>
</ol>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To try out these tutorials you need to get a clone of the repository, since it is not yet released.</p>
</div>
</section>
</section>
<div class="navbar" style="text-align:right;">
<a class="prev" title="Histogram" href="index.html"><img src="../_static/prev.png" alt="prev"/></a>
<a class="up" title="Histogram" href="index.html"><img src="../_static/up.png" alt="up"/></a>
<a class="next" title="Create a histogram" href="create.html"><img src="../_static/next.png" alt="next"/></a>
</div>
</div>
<div class="footer" role="contentinfo">
Last updated on 2024-05-10 07:05:03.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>