boost/libs/gil/doc/html/reference/group___image_model.html
2021-10-05 21:37:46 +02:00

152 lines
10 KiB
HTML

<!-- HTML header for doxygen 1.8.13-->
<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Generic Image Library: Models</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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div class="boost-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="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
</td>
<td ><h1 align="center"><a href="../index.html"></a></h1></td>
<td></td>
</tr>
</table>
</div>
<hr/>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle">
<div class="title">Models<div class="ingroups"><a class="el" href="group___image.html">Image</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Image models.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1image.html">image&lt; Pixel, IsPlanar, Alloc &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">container interface over image view. Models <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a> <a href="classboost_1_1gil_1_1image.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image&lt; Images &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a run-time specified image. Note it does NOT model <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>. <a href="classboost_1_1gil_1_1any__image.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
view, const_view</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp907678f703e824fe30e4e6f52ffbd776"></a>Get an image view from a run-time instantiated image </p>
</td></tr>
<tr class="memitem:ga633557dbbff2d21c784b73412b47bb38"><td class="memTemplParams" colspan="2"><a id="ga633557dbbff2d21c784b73412b47bb38"></a>
template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
<tr class="memitem:ga633557dbbff2d21c784b73412b47bb38"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt;::view_t &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_model.html#ga633557dbbff2d21c784b73412b47bb38">view</a> (<a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)</td></tr>
<tr class="memdesc:ga633557dbbff2d21c784b73412b47bb38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the non-constant-pixel view of an image. <br /></td></tr>
<tr class="separator:ga633557dbbff2d21c784b73412b47bb38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga280baf3f2255f3c57b749af075a921fc"><td class="memTemplParams" colspan="2">template&lt;typename ... Images&gt; </td></tr>
<tr class="memitem:ga280baf3f2255f3c57b749af075a921fc"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_model.html#ga280baf3f2255f3c57b749af075a921fc">view</a> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt;::view_t</td></tr>
<tr class="memdesc:ga280baf3f2255f3c57b749af075a921fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the non-constant-pixel view of any image. The returned view is any view. <a href="group___image_model.html#ga280baf3f2255f3c57b749af075a921fc">More...</a><br /></td></tr>
<tr class="separator:ga280baf3f2255f3c57b749af075a921fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63786c67206d1a2cc3b31abf7c14d6e7"><td class="memTemplParams" colspan="2">template&lt;typename ... Images&gt; </td></tr>
<tr class="memitem:ga63786c67206d1a2cc3b31abf7c14d6e7"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_model.html#ga63786c67206d1a2cc3b31abf7c14d6e7">const_view</a> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; const &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt;::const_view_t</td></tr>
<tr class="memdesc:ga63786c67206d1a2cc3b31abf7c14d6e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the constant-pixel view of any image. The returned view is any view. <a href="group___image_model.html#ga63786c67206d1a2cc3b31abf7c14d6e7">More...</a><br /></td></tr>
<tr class="separator:ga63786c67206d1a2cc3b31abf7c14d6e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0505866ffb317dcd320e74be9874f950"><td class="memTemplParams" colspan="2"><a id="ga0505866ffb317dcd320e74be9874f950"></a>
template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
<tr class="memitem:ga0505866ffb317dcd320e74be9874f950"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt;::const_view_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_model.html#ga0505866ffb317dcd320e74be9874f950">const_view</a> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)</td></tr>
<tr class="memdesc:ga0505866ffb317dcd320e74be9874f950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the constant-pixel view of an image. <br /></td></tr>
<tr class="separator:ga0505866ffb317dcd320e74be9874f950"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Image models. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga63786c67206d1a2cc3b31abf7c14d6e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63786c67206d1a2cc3b31abf7c14d6e7">&#9670;&nbsp;</a></span>const_view()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BOOST_FORCEINLINE auto boost::gil::const_view </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; const &amp;&#160;</td>
<td class="paramname"><em>img</em></td><td>)</td>
<td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Images...&gt;::const_view_t
</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the constant-pixel view of any image. The returned view is any view. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Types</td><td>Models ImageVectorConcept </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga280baf3f2255f3c57b749af075a921fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga280baf3f2255f3c57b749af075a921fc">&#9670;&nbsp;</a></span>view()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BOOST_FORCEINLINE auto boost::gil::view </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Images... &gt; &amp;&#160;</td>
<td class="paramname"><em>img</em></td><td>)</td>
<td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Images...&gt;::view_t
</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the non-constant-pixel view of any image. The returned view is any view. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Images</td><td>Models ImageVectorConcept </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
</small>
</address>
</body>
</html>