libs/gil/doc/html/reference/structboost_1_1gil_1_1planar__pixel__iterator.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: planar_pixel_iterator&lt; ChannelPtr, ColorSpace &gt; Struct Template Reference</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 id="nav-path" class="navpath">
  41   <ul>
  42 <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-types">Public Types</a> &#124;
  48 <a href="#pub-methods">Public Member Functions</a> &#124;
  49 <a href="#friends">Friends</a> &#124;
  50 <a href="structboost_1_1gil_1_1planar__pixel__iterator-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">planar_pixel_iterator&lt; ChannelPtr, ColorSpace &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_iterator.html">Pixel Iterator</a> &raquo; <a class="el" href="group___pixel_iterator_model.html">Models</a> &raquo; <a class="el" href="group___pixel_iterator_model_planar_ptr.html">planar_pixel_iterator</a><a class="el" href="group___color_base.html">ColorBase</a> &raquo; <a class="el" href="group___color_base_model.html">Models</a> &raquo;  &#124; <a class="el" href="group___color_base_model_planar_ptr.html">planar_pixel_iterator</a><a class="el" href="group___pixel_based.html">PixelBased</a> &raquo;  &#124; <a class="el" href="group___pixel_based_model.html">Models</a></div></div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55
  56 <p>An iterator over planar pixels. Models <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_concept.html" title="Color base whose elements all have the same type.">HomogeneousColorBaseConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_homogeneous_pixel_based_concept.html" title="Concept for homogeneous pixel-based GIL constructs.">HomogeneousPixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_memory_based_iterator_concept.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or bits)">MemoryBasedIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>.
  57  <a href="structboost_1_1gil_1_1planar__pixel__iterator.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="planar__pixel__iterator_8hpp_source.html">planar_pixel_iterator.hpp</a>&gt;</code></p>
  60
  61 <p>Inherits iterator_facade&lt; planar_pixel_iterator&lt; ChannelPtr, ColorSpace &gt;, pixel&lt; std::iterator_traits&lt; ChannelPtr &gt;::value_type, layout&lt; ColorSpace &gt; &gt;, std::random_access_iterator_tag, planar_pixel_reference&lt; std::iterator_traits&lt; ChannelPtr &gt;::reference, ColorSpace &gt; const &gt;, and homogeneous_color_base&lt; Element, Layout, K &gt;.</p>
  62 <table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  64 Public Types</h2></td></tr>
  65 <tr class="memitem:afd238dfd8f488211873e22cbd509b3da"><td class="memItemLeft" align="right" valign="top"><a id="afd238dfd8f488211873e22cbd509b3da"></a>
  66 using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = typename parent_t::value_type</td></tr>
  67 <tr class="separator:afd238dfd8f488211873e22cbd509b3da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memItemLeft" align="right" valign="top"><a id="afd3670b743c9f80b9c2f6b3ccb5fe37c"></a>
  69 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename parent_t::reference</td></tr>
  70 <tr class="separator:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memItemLeft" align="right" valign="top"><a id="a2ae9f9bc144b7bd7d8523c345ac34a58"></a>
  72 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename parent_t::difference_type</td></tr>
  73 <tr class="separator:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 </table><table class="memberdecls">
  75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76 Public Member Functions</h2></td></tr>
  77 <tr class="memitem:af7f4c6e930eae79d9f5a16e8dc57a306"><td class="memItemLeft" align="right" valign="top"><a id="af7f4c6e930eae79d9f5a16e8dc57a306"></a>
  78 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_iterator</b> (bool)</td></tr>
  79 <tr class="separator:af7f4c6e930eae79d9f5a16e8dc57a306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:aea18ad75ac3b0be15eb771ac1c3971dc"><td class="memItemLeft" align="right" valign="top"><a id="aea18ad75ac3b0be15eb771ac1c3971dc"></a>
  81 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_iterator</b> (const ChannelPtr &amp;v0, const ChannelPtr &amp;v1)</td></tr>
  82 <tr class="separator:aea18ad75ac3b0be15eb771ac1c3971dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:a28877cb865567e049fe9682b1fd88d0e"><td class="memItemLeft" align="right" valign="top"><a id="a28877cb865567e049fe9682b1fd88d0e"></a>
  84 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_iterator</b> (const ChannelPtr &amp;v0, const ChannelPtr &amp;v1, const ChannelPtr &amp;v2)</td></tr>
  85 <tr class="separator:a28877cb865567e049fe9682b1fd88d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:ada13c4e8f8920e61b83a64070fdc40c0"><td class="memItemLeft" align="right" valign="top"><a id="ada13c4e8f8920e61b83a64070fdc40c0"></a>
  87 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_iterator</b> (const ChannelPtr &amp;v0, const ChannelPtr &amp;v1, const ChannelPtr &amp;v2, const ChannelPtr &amp;v3)</td></tr>
  88 <tr class="separator:ada13c4e8f8920e61b83a64070fdc40c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:ae745f60902f8b2aa33e3972cf7593e82"><td class="memItemLeft" align="right" valign="top"><a id="ae745f60902f8b2aa33e3972cf7593e82"></a>
  90 &#160;</td><td class="memItemRight" valign="bottom"><b>planar_pixel_iterator</b> (const ChannelPtr &amp;v0, const ChannelPtr &amp;v1, const ChannelPtr &amp;v2, const ChannelPtr &amp;v3, const ChannelPtr &amp;v4)</td></tr>
  91 <tr class="separator:ae745f60902f8b2aa33e3972cf7593e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:aa04d2687326b7016ae83d1b7b1a529d2"><td class="memTemplParams" colspan="2"><a id="aa04d2687326b7016ae83d1b7b1a529d2"></a>
  93 template&lt;typename IC1 , typename C1 &gt; </td></tr>
  94 <tr class="memitem:aa04d2687326b7016ae83d1b7b1a529d2"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>planar_pixel_iterator</b> (const <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC1, C1 &gt; &amp;ptr)</td></tr>
  95 <tr class="separator:aa04d2687326b7016ae83d1b7b1a529d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:a17b05b4a8da5c31609da1e02bd7ebed1"><td class="memTemplParams" colspan="2">template&lt;typename P &gt; </td></tr>
  97 <tr class="memitem:a17b05b4a8da5c31609da1e02bd7ebed1"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html#a17b05b4a8da5c31609da1e02bd7ebed1">planar_pixel_iterator</a> (P *pix)</td></tr>
  98 <tr class="separator:a17b05b4a8da5c31609da1e02bd7ebed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 <tr class="memitem:a6b20b61a1c2d53cefac45896913e353f"><td class="memTemplParams" colspan="2"><a id="a6b20b61a1c2d53cefac45896913e353f"></a>
 100 template&lt;typename P &gt; </td></tr>
 101 <tr class="memitem:a6b20b61a1c2d53cefac45896913e353f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (P *pix)</td></tr>
 102 <tr class="separator:a6b20b61a1c2d53cefac45896913e353f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 <tr class="memitem:a16d8e6857dd561244ca73764f2b94801"><td class="memItemLeft" align="right" valign="top">reference&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a> (difference_type d) const</td></tr>
 104 <tr class="separator:a16d8e6857dd561244ca73764f2b94801"><td class="memSeparator" colspan="2">&#160;</td></tr>
 105 <tr class="memitem:a805e05f32890139f6f2665c7ec37bf6e"><td class="memItemLeft" align="right" valign="top"><a id="a805e05f32890139f6f2665c7ec37bf6e"></a>
 106 reference&#160;</td><td class="memItemRight" valign="bottom"><b>operator-&gt;</b> () const</td></tr>
 107 <tr class="separator:a805e05f32890139f6f2665c7ec37bf6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:a6de5530ab982b221dbcd0e1383882c81"><td class="memItemLeft" align="right" valign="top"><a id="a6de5530ab982b221dbcd0e1383882c81"></a>
 109 bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a> &amp;ptr) const</td></tr>
 110 <tr class="separator:a6de5530ab982b221dbcd0e1383882c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 <tr class="memitem:a40a5c353e71dc2d07f2446a88dd03ce7"><td class="memItemLeft" align="right" valign="top"><a id="a40a5c353e71dc2d07f2446a88dd03ce7"></a>
 112 bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a> &amp;ptr) const</td></tr>
 113 <tr class="separator:a40a5c353e71dc2d07f2446a88dd03ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 </table><table class="memberdecls">
 115 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
 116 Friends</h2></td></tr>
 117 <tr class="memitem:ac09f73e325921cc50ebcd96bed0f8096"><td class="memItemLeft" align="right" valign="top"><a id="ac09f73e325921cc50ebcd96bed0f8096"></a>
 118 class&#160;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
 119 <tr class="separator:ac09f73e325921cc50ebcd96bed0f8096"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 </table>
 121 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 122 <div class="textblock"><h3>template&lt;typename ChannelPtr, typename ColorSpace&gt;<br />
 123 struct boost::gil::planar_pixel_iterator&lt; ChannelPtr, ColorSpace &gt;</h3>
 124
 125 <p>An iterator over planar pixels. Models <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_concept.html" title="Color base whose elements all have the same type.">HomogeneousColorBaseConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_homogeneous_pixel_based_concept.html" title="Concept for homogeneous pixel-based GIL constructs.">HomogeneousPixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_memory_based_iterator_concept.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or bits)">MemoryBasedIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>. </p>
 126 <p>Planar pixels have channel data that is not consecutive in memory. To abstract this we use classes to represent references and pointers to planar pixels. </p>
 127 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 128 <a id="a17b05b4a8da5c31609da1e02bd7ebed1"></a>
 129 <h2 class="memtitle"><span class="permalink"><a href="#a17b05b4a8da5c31609da1e02bd7ebed1">&#9670;&nbsp;</a></span>planar_pixel_iterator()</h2>
 130
 131 <div class="memitem">
 132 <div class="memproto">
 133 <table class="mlabels">
 134   <tr>
 135   <td class="mlabels-left">
 136       <table class="memname">
 137         <tr>
 138           <td class="memname"><a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a> </td>
 139           <td>(</td>
 140           <td class="paramtype">P *&#160;</td>
 141           <td class="paramname"><em>pix</em></td><td>)</td>
 142           <td></td>
 143         </tr>
 144       </table>
 145   </td>
 146   <td class="mlabels-right">
 147 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 148   </tr>
 149 </table>
 150 </div><div class="memdoc">
 151 <p>Copy constructor and operator= from pointers to compatible planar pixels or planar pixel references. That allow constructs like pointer = &amp;value or pointer = &amp;reference Since we should not override operator&amp; that's the best we can do. </p>
 152
 153 </div>
 154 </div>
 155 <h2 class="groupheader">Member Function Documentation</h2>
 156 <a id="a16d8e6857dd561244ca73764f2b94801"></a>
 157 <h2 class="memtitle"><span class="permalink"><a href="#a16d8e6857dd561244ca73764f2b94801">&#9670;&nbsp;</a></span>operator[]()</h2>
 158
 159 <div class="memitem">
 160 <div class="memproto">
 161 <table class="mlabels">
 162   <tr>
 163   <td class="mlabels-left">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">reference operator[] </td>
 167           <td>(</td>
 168           <td class="paramtype">difference_type&#160;</td>
 169           <td class="paramname"><em>d</em></td><td>)</td>
 170           <td> const</td>
 171         </tr>
 172       </table>
 173   </td>
 174   <td class="mlabels-right">
 175 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 176   </tr>
 177 </table>
 178 </div><div class="memdoc">
 179 <p>For some reason operator[] provided by iterator_facade returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits </p>
 180
 181 </div>
 182 </div>
 183 <hr/>The documentation for this struct was generated from the following files:<ul>
 184 <li><a class="el" href="algorithm_8hpp_source.html">algorithm.hpp</a></li>
 185 <li><a class="el" href="planar__pixel__iterator_8hpp_source.html">planar_pixel_iterator.hpp</a></li>
 186 </ul>
 187 </div><!-- contents -->
 188      <!-- HTML footer for doxygen 1.8.13-->
 189      <!-- start footer part -->
 190      <hr class="footer"/>
 191      <address class="footer">
 192       <small>
 193         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 194       </small>
 195     </address>
 196   </body>
 197 </html>