boost/gil
2
0
Fork 0
mirror of https://github.com/boostorg/gil.git synced 2026-01-26 06:32:16 +00:00
Code Issues Projects Releases Wiki Activity
Files
gh-pages
gil/develop/doc/html/index.html
github-actions[bot] 62e86ae346 deploy: 4115f5b5d3
2026-01-23 01:40:49 +00:00

206 lines
13 KiB
HTML
Raw Permalink Blame History

<!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="viewport" content="width=device-width, initial-scale=1" />
<title>Boost Generic Image Library - 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/doctools.js"></script>
<script type="text/javascript" src="_static/sphinx_highlight.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="#" />
<link rel="next" title="Installation" href="installation.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="#"><img
alt="C++ Boost" src="_static/gil.png" border="0"></a></h3>
</td>
<td >
<h1 align="center"><a href="#"></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="next" title="Installation" href="installation.html"><img src="_static/next.png" alt="next"/></a>
</div>
<section id="boost-generic-image-library">
<h1>Boost Generic Image Library<a class="headerlink" href="#boost-generic-image-library" title="Link to this heading"></a></h1>
<p>The Generic Image Library (GIL) is a C++14 header-only library that abstracts image
representations from algorithms and allows writing code that can work on
a variety of images with performance similar to hand-writing for a specific
image type.</p>
<section id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/video.html">Tutorial: Video Lecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/histogram.html">Tutorial: Histogram</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/gradient.html">Tutorial: Image Gradient</a></li>
<li class="toctree-l1"><a class="reference internal" href="naming.html">Naming Conventions</a></li>
</ul>
</div>
</section>
<section id="core-library-documentation">
<h2>Core Library Documentation<a class="headerlink" href="#core-library-documentation" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="design/index.html">Design Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="design/basics.html">Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/concepts.html">Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/point.html">Point</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/channel.html">Channel</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/color_space.html">Color Space and Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/color_base.html">Color Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/pixel.html">Pixel</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/pixel_iterator.html">Pixel Iterator</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/pixel_locator.html">Pixel Locator</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/image_view.html">Image View</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/image.html">Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/dynamic_image.html">Dynamic images and image views</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/metafunctions.html">Metafunctions</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/examples.html">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/technicalities.html">Technicalities</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/extending.html">Extending</a></li>
<li class="toctree-l2"><a class="reference internal" href="design/conclusions.html">Conclusions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="image_processing/index.html">Image Processing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="image_processing/overview.html">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="image_processing/basics.html">Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="image_processing/affine-region-detectors.html">Affine region detectors</a></li>
<li class="toctree-l2"><a class="reference internal" href="image_processing/contrast_enhancement/index.html">Contrast Enhancement</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="histogram/index.html">Histogram</a><ul>
<li class="toctree-l2"><a class="reference internal" href="histogram/overview.html">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/create.html">Create a histogram</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/fill.html">Fill histogram</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/subhistogram.html">Making a sub-histogram</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/cumulative.html">Making a cumulative histogram</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/stl_compatibility.html">STL compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/utilities.html">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/extend.html">Extending the class</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/limitations.html">Limitations</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/extension/index.html">Extensions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="./reference/index.html#://">API Reference</a></li>
</ul>
</div>
</section>
<section id="extensions-documentation">
<h2>Extensions Documentation<a class="headerlink" href="#extensions-documentation" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="io.html">IO extensions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="io.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="io.html#supported-platforms">Supported Platforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="io.html#tutorial">Tutorial</a></li>
<li class="toctree-l2"><a class="reference internal" href="io.html#using-io">Using IO</a></li>
<li class="toctree-l2"><a class="reference internal" href="io.html#running-gil-io-tests">Running gil::io tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="toolbox.html">ToolBox extension</a><ul>
<li class="toctree-l2"><a class="reference internal" href="toolbox.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="toolbox.html#folder-structure">Folder Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="toolbox.html#acknowledgements">Acknowledgements</a></li>
<li class="toctree-l2"><a class="reference internal" href="toolbox.html#id1">Reference</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="numeric.html">Numeric extension</a><ul>
<li class="toctree-l2"><a class="reference internal" href="numeric.html#overview">Overview</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="histogram/extension/index.html">Extensions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="histogram/extension/overview.html">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="histogram/extension/std.html">STD extension</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference download internal" download="" href="_downloads/616376c46b838d872b7904380511497a/x_gradient.cpp"><code class="xref download docutils literal notranslate"><span class="pre">x_gradient.cpp</span></code></a>:
Writing an algorithm that operates on generic images</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/86f1b8e9b08838cff5344407372254d5/dynamic_image.cpp"><code class="xref download docutils literal notranslate"><span class="pre">dynamic_image.cpp</span></code></a>:
Using images whose properties (color space, channel type) are specified
at run time</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/a17e372b9fcd3d6d9436c0013af6cf2d/histogram.cpp"><code class="xref download docutils literal notranslate"><span class="pre">histogram.cpp</span></code></a>: Creating a histogram</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/65c1749946f416eafea12816c3b48bb3/interleaved_ptr.cpp"><code class="xref download docutils literal notranslate"><span class="pre">interleaved_ptr.cpp</span></code></a>,
<a class="reference download internal" download="" href="_downloads/f95b413acffa7d2810b20eade62d96e1/interleaved_ptr.hpp"><code class="xref download docutils literal notranslate"><span class="pre">interleaved_ptr.hpp</span></code></a>,
<a class="reference download internal" download="" href="_downloads/28d309347788ce07e2fdcefc93d075d8/interleaved_ref.hpp"><code class="xref download docutils literal notranslate"><span class="pre">interleaved_ref.hpp</span></code></a>:
Creating your own pixel reference and pixel iterator</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/f4c32f08ec375899f01a3efd07a22e4b/mandelbrot.cpp"><code class="xref download docutils literal notranslate"><span class="pre">mandelbrot.cpp</span></code></a>:
Creating a synthetic image defined by a function</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/7091060bbcab0bd172d9fa706158bc7f/packed_pixel.cpp"><code class="xref download docutils literal notranslate"><span class="pre">packed_pixel.cpp</span></code></a>:
Defining bitmasks and images whose channels or pixels are not byte-aligned</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/ba63289b75f676482437f0ac38e964ca/resize.cpp"><code class="xref download docutils literal notranslate"><span class="pre">resize.cpp</span></code></a>:
Rescaling an image using bilinear sampling (requires the optional
Numeric extension)</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/22415bc21655eea6105744ecdce0536e/affine.cpp"><code class="xref download docutils literal notranslate"><span class="pre">affine.cpp</span></code></a>:
Applying an affine transformation to an image (requires the optional
Numeric extension)</p></li>
<li><p><a class="reference download internal" download="" href="_downloads/975e2af95a20efe1ab7b36bc39833e6a/convolution.cpp"><code class="xref download docutils literal notranslate"><span class="pre">convolution.cpp</span></code></a>:
Blurring images (requires the optional Numeric extension)</p></li>
</ul>
</section>
</section>
<div class="navbar" style="text-align:right;">
<a class="next" title="Installation" href="installation.html"><img src="_static/next.png" alt="next"/></a>
</div>
</div>
<div class="footer" role="contentinfo">
Last updated on 2026-01-23 01:01:39.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink