libs/gil/doc/html/reference/group___image_model.html

   1 <!-- HTML header for doxygen 1.8.13-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7     <meta name="generator" content="Doxygen 1.8.15"/>
   8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9     <title>Generic Image Library: Models</title>
  10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11     <script type="text/javascript" src="jquery.js"></script>
  12     <script type="text/javascript" src="dynsections.js"></script>
  13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15   </head>
  16   <body>
  17     <div class="boost-header">
  18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19         <tr>
  20           <td valign="top" width="300">
  21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22           </td>
  23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24           <td></td>
  25         </tr>
  26       </table>
  27     </div>
  28     <hr/>
  29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30 <!-- Generated by Doxygen 1.8.15 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Classes</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">Models<div class="ingroups"><a class="el" href="group___image.html">Image</a></div></div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48
  49 <p>Image models.
  50 <a href="#details">More...</a></p>
  51 <table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  53 Classes</h2></td></tr>
  54 <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>
  55 <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>
  56 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 <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>
  58 <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>
  59 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 </table><table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  62 view, const_view</h2></td></tr>
  63 <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp907678f703e824fe30e4e6f52ffbd776"></a>Get an image view from a run-time instantiated image </p>
  64 </td></tr>
  65 <tr class="memitem:ga633557dbbff2d21c784b73412b47bb38"><td class="memTemplParams" colspan="2"><a id="ga633557dbbff2d21c784b73412b47bb38"></a>
  66 template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
  67 <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>
  68 <tr class="memdesc:ga633557dbbff2d21c784b73412b47bb38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the non-constant-pixel view of an image. <br /></td></tr>
  69 <tr class="separator:ga633557dbbff2d21c784b73412b47bb38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:ga20dfbc320bba6fb37f5e119e0eb30ffd"><td class="memTemplParams" colspan="2">template&lt;typename Types &gt; </td></tr>
  71 <tr class="memitem:ga20dfbc320bba6fb37f5e119e0eb30ffd"><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#ga20dfbc320bba6fb37f5e119e0eb30ffd">view</a> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt; &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt;::view_t</td></tr>
  72 <tr class="memdesc:ga20dfbc320bba6fb37f5e119e0eb30ffd"><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#ga20dfbc320bba6fb37f5e119e0eb30ffd">More...</a><br /></td></tr>
  73 <tr class="separator:ga20dfbc320bba6fb37f5e119e0eb30ffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:ga7dd4401bba8562a65a7e94bd46b603ce"><td class="memTemplParams" colspan="2">template&lt;typename Types &gt; </td></tr>
  75 <tr class="memitem:ga7dd4401bba8562a65a7e94bd46b603ce"><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#ga7dd4401bba8562a65a7e94bd46b603ce">const_view</a> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt; const &amp;img) -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt;::const_view_t</td></tr>
  76 <tr class="memdesc:ga7dd4401bba8562a65a7e94bd46b603ce"><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#ga7dd4401bba8562a65a7e94bd46b603ce">More...</a><br /></td></tr>
  77 <tr class="separator:ga7dd4401bba8562a65a7e94bd46b603ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:ga0505866ffb317dcd320e74be9874f950"><td class="memTemplParams" colspan="2"><a id="ga0505866ffb317dcd320e74be9874f950"></a>
  79 template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
  80 <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>
  81 <tr class="memdesc:ga0505866ffb317dcd320e74be9874f950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the constant-pixel view of an image. <br /></td></tr>
  82 <tr class="separator:ga0505866ffb317dcd320e74be9874f950"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 </table>
  84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85 <p>Image models. </p>
  86 <h2 class="groupheader">Function Documentation</h2>
  87 <a id="ga7dd4401bba8562a65a7e94bd46b603ce"></a>
  88 <h2 class="memtitle"><span class="permalink"><a href="#ga7dd4401bba8562a65a7e94bd46b603ce">&#9670;&nbsp;</a></span>const_view()</h2>
  89
  90 <div class="memitem">
  91 <div class="memproto">
  92       <table class="memname">
  93         <tr>
  94           <td class="memname">BOOST_FORCEINLINE auto boost::gil::const_view </td>
  95           <td>(</td>
  96           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt; const &amp;&#160;</td>
  97           <td class="paramname"><em>img</em></td><td>)</td>
  98           <td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Types&gt;::const_view_t
  99 </td>
 100         </tr>
 101       </table>
 102 </div><div class="memdoc">
 103
 104 <p>Returns the constant-pixel view of any image. The returned view is any view. </p>
 105 <dl class="tparams"><dt>Template Parameters</dt><dd>
 106   <table class="tparams">
 107     <tr><td class="paramname">Types</td><td>Models ImageVectorConcept </td></tr>
 108   </table>
 109   </dd>
 110 </dl>
 111
 112 </div>
 113 </div>
 114 <a id="ga20dfbc320bba6fb37f5e119e0eb30ffd"></a>
 115 <h2 class="memtitle"><span class="permalink"><a href="#ga20dfbc320bba6fb37f5e119e0eb30ffd">&#9670;&nbsp;</a></span>view()</h2>
 116
 117 <div class="memitem">
 118 <div class="memproto">
 119       <table class="memname">
 120         <tr>
 121           <td class="memname">BOOST_FORCEINLINE auto boost::gil::view </td>
 122           <td>(</td>
 123           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt; &amp;&#160;</td>
 124           <td class="paramname"><em>img</em></td><td>)</td>
 125           <td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Types&gt;::view_t
 126 </td>
 127         </tr>
 128       </table>
 129 </div><div class="memdoc">
 130
 131 <p>Returns the non-constant-pixel view of any image. The returned view is any view. </p>
 132 <dl class="tparams"><dt>Template Parameters</dt><dd>
 133   <table class="tparams">
 134     <tr><td class="paramname">Types</td><td>Models ImageVectorConcept </td></tr>
 135   </table>
 136   </dd>
 137 </dl>
 138
 139 </div>
 140 </div>
 141 </div><!-- contents -->
 142      <!-- HTML footer for doxygen 1.8.13-->
 143      <!-- start footer part -->
 144      <hr class="footer"/>
 145      <address class="footer">
 146       <small>
 147         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 148       </small>
 149     </address>
 150   </body>
 151 </html>