group___image_model.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  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. <p>Image models.
  49. <a href="#details">More...</a></p>
  50. <table class="memberdecls">
  51. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  52. Classes</h2></td></tr>
  53. <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>
  54. <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>
  55. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <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>
  57. <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>
  58. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. </table><table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  61. view, const_view</h2></td></tr>
  62. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp907678f703e824fe30e4e6f52ffbd776"></a>Get an image view from a run-time instantiated image </p>
  63. </td></tr>
  64. <tr class="memitem:ga633557dbbff2d21c784b73412b47bb38"><td class="memTemplParams" colspan="2"><a id="ga633557dbbff2d21c784b73412b47bb38"></a>
  65. template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
  66. <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>
  67. <tr class="memdesc:ga633557dbbff2d21c784b73412b47bb38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the non-constant-pixel view of an image. <br /></td></tr>
  68. <tr class="separator:ga633557dbbff2d21c784b73412b47bb38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga20dfbc320bba6fb37f5e119e0eb30ffd"><td class="memTemplParams" colspan="2">template&lt;typename Types &gt; </td></tr>
  70. <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>
  71. <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>
  72. <tr class="separator:ga20dfbc320bba6fb37f5e119e0eb30ffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ga7dd4401bba8562a65a7e94bd46b603ce"><td class="memTemplParams" colspan="2">template&lt;typename Types &gt; </td></tr>
  74. <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>
  75. <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>
  76. <tr class="separator:ga7dd4401bba8562a65a7e94bd46b603ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga0505866ffb317dcd320e74be9874f950"><td class="memTemplParams" colspan="2"><a id="ga0505866ffb317dcd320e74be9874f950"></a>
  78. template&lt;typename Pixel , bool IsPlanar, typename Alloc &gt; </td></tr>
  79. <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>
  80. <tr class="memdesc:ga0505866ffb317dcd320e74be9874f950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the constant-pixel view of an image. <br /></td></tr>
  81. <tr class="separator:ga0505866ffb317dcd320e74be9874f950"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. </table>
  83. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  84. <p>Image models. </p>
  85. <h2 class="groupheader">Function Documentation</h2>
  86. <a id="ga7dd4401bba8562a65a7e94bd46b603ce"></a>
  87. <h2 class="memtitle"><span class="permalink"><a href="#ga7dd4401bba8562a65a7e94bd46b603ce">&#9670;&nbsp;</a></span>const_view()</h2>
  88. <div class="memitem">
  89. <div class="memproto">
  90. <table class="memname">
  91. <tr>
  92. <td class="memname">BOOST_FORCEINLINE auto boost::gil::const_view </td>
  93. <td>(</td>
  94. <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt; const &amp;&#160;</td>
  95. <td class="paramname"><em>img</em></td><td>)</td>
  96. <td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Types&gt;::const_view_t
  97. </td>
  98. </tr>
  99. </table>
  100. </div><div class="memdoc">
  101. <p>Returns the constant-pixel view of any image. The returned view is any view. </p>
  102. <dl class="tparams"><dt>Template Parameters</dt><dd>
  103. <table class="tparams">
  104. <tr><td class="paramname">Types</td><td>Models ImageVectorConcept </td></tr>
  105. </table>
  106. </dd>
  107. </dl>
  108. </div>
  109. </div>
  110. <a id="ga20dfbc320bba6fb37f5e119e0eb30ffd"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#ga20dfbc320bba6fb37f5e119e0eb30ffd">&#9670;&nbsp;</a></span>view()</h2>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname">BOOST_FORCEINLINE auto boost::gil::view </td>
  117. <td>(</td>
  118. <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; Types &gt; &amp;&#160;</td>
  119. <td class="paramname"><em>img</em></td><td>)</td>
  120. <td> -&gt; typename <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt;Types&gt;::view_t
  121. </td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>Returns the non-constant-pixel view of any image. The returned view is any view. </p>
  126. <dl class="tparams"><dt>Template Parameters</dt><dd>
  127. <table class="tparams">
  128. <tr><td class="paramname">Types</td><td>Models ImageVectorConcept </td></tr>
  129. </table>
  130. </dd>
  131. </dl>
  132. </div>
  133. </div>
  134. </div><!-- contents -->
  135. <!-- HTML footer for doxygen 1.8.13-->
  136. <!-- start footer part -->
  137. <hr class="footer"/>
  138. <address class="footer">
  139. <small>
  140. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  141. </small>
  142. </address>
  143. </body>
  144. </html>