group___image_view_transformations_nth_channel.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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: nth_channel_view</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> &#124;
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle">
  46. <div class="title">nth_channel_view<div class="ingroups"><a class="el" href="group___image_view.html">Image View</a> &raquo; <a class="el" href="group___image_view_algorithm.html">Algorithms and Utility Functions</a> &raquo; <a class="el" href="group___image_view_transformations.html">Image View Transformations</a></div></div> </div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p>single-channel (grayscale) view of the N-th channel of a given <a class="el" href="classboost_1_1gil_1_1image__view.html" title="A lightweight object that interprets memory as a 2D array of pixels. Models ImageViewConcept,...">image_view</a>
  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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1nth__channel__view__type.html">nth_channel_view_type&lt; View &gt;</a></td></tr>
  55. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a source image view type View, returns the type of an image view over a single channel of ViewIf the channels in the source view are adjacent in memory (such as planar non-step view or single-channel view) then the return view is a single-channel non-step view. If the channels are non-adjacent (interleaved and/or step view) then the return view is a single-channel step view. <a href="structboost_1_1gil_1_1nth__channel__view__type.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1nth__channel__view__type_3_01any__image__view_3_01_views_01_4_01_4.html">nth_channel_view_type&lt; any_image_view&lt; Views &gt; &gt;</a></td></tr>
  58. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a runtime source image view, returns the type of a runtime image view over a single channel of the source view. <a href="structboost_1_1gil_1_1nth__channel__view__type_3_01any__image__view_3_01_views_01_4_01_4.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="func-members"></a>
  62. Functions</h2></td></tr>
  63. <tr class="memitem:gad976e8c51016d9cdbb47d57ab2ce8717"><td class="memTemplParams" colspan="2"><a id="gad976e8c51016d9cdbb47d57ab2ce8717"></a>
  64. template&lt;typename View &gt; </td></tr>
  65. <tr class="memitem:gad976e8c51016d9cdbb47d57ab2ce8717"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1nth__channel__view__type.html">nth_channel_view_type</a>&lt; View &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>nth_channel_view</b> (const View &amp;src, int n)</td></tr>
  66. <tr class="separator:gad976e8c51016d9cdbb47d57ab2ce8717"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ga459665184d07a1121424e99478aea947"><td class="memTemplParams" colspan="2">template&lt;typename Views &gt; </td></tr>
  68. <tr class="memitem:ga459665184d07a1121424e99478aea947"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_transformations_nth_channel.html#ga459665184d07a1121424e99478aea947">nth_channel_view</a> (const <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; Views &gt; &amp;src, int n) -&gt; typename <a class="el" href="structboost_1_1gil_1_1nth__channel__view__type.html">nth_channel_view_type</a>&lt; <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; Views &gt;&gt;::type</td></tr>
  69. <tr class="separator:ga459665184d07a1121424e99478aea947"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. </table>
  71. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  72. <p>single-channel (grayscale) view of the N-th channel of a given <a class="el" href="classboost_1_1gil_1_1image__view.html" title="A lightweight object that interprets memory as a 2D array of pixels. Models ImageViewConcept,...">image_view</a> </p>
  73. <h2 class="groupheader">Function Documentation</h2>
  74. <a id="ga459665184d07a1121424e99478aea947"></a>
  75. <h2 class="memtitle"><span class="permalink"><a href="#ga459665184d07a1121424e99478aea947">&#9670;&nbsp;</a></span>nth_channel_view()</h2>
  76. <div class="memitem">
  77. <div class="memproto">
  78. <table class="mlabels">
  79. <tr>
  80. <td class="mlabels-left">
  81. <table class="memname">
  82. <tr>
  83. <td class="memname">auto boost::gil::nth_channel_view </td>
  84. <td>(</td>
  85. <td class="paramtype">const <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; Views &gt; &amp;&#160;</td>
  86. <td class="paramname"><em>src</em>, </td>
  87. </tr>
  88. <tr>
  89. <td class="paramkey"></td>
  90. <td></td>
  91. <td class="paramtype">int&#160;</td>
  92. <td class="paramname"><em>n</em>&#160;</td>
  93. </tr>
  94. <tr>
  95. <td></td>
  96. <td>)</td>
  97. <td></td><td> -&gt; typename <a class="el" href="structboost_1_1gil_1_1nth__channel__view__type.html">nth_channel_view_type</a>&lt;<a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt;Views&gt;&gt;::type
  98. </td>
  99. </tr>
  100. </table>
  101. </td>
  102. <td class="mlabels-right">
  103. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  104. </tr>
  105. </table>
  106. </div><div class="memdoc">
  107. <dl class="tparams"><dt>Template Parameters</dt><dd>
  108. <table class="tparams">
  109. <tr><td class="paramname">Views</td><td>Models Boost.MP11-compatible list of models of <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a> </td></tr>
  110. </table>
  111. </dd>
  112. </dl>
  113. </div>
  114. </div>
  115. </div><!-- contents -->
  116. <!-- HTML footer for doxygen 1.8.13-->
  117. <!-- start footer part -->
  118. <hr class="footer"/>
  119. <address class="footer">
  120. <small>
  121. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  122. </small>
  123. </address>
  124. </body>
  125. </html>