concepts_2image_8hpp_source.html 22 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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: image.hpp Source File</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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_df4750f408086f9b9c1b5ee4251365ff.html">gil</a></li><li class="navelem"><a class="el" href="dir_65525b100b86579f1f0652bf33388089.html">concepts</a></li> </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="headertitle">
  47. <div class="title">concepts/image.hpp</div> </div>
  48. </div><!--header-->
  49. <div class="contents">
  50. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Distributed under the Boost Software License, Version 1.0</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// See accompanying file LICENSE_1_0.txt or copy at</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.boost.org/LICENSE_1_0.txt</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef BOOST_GIL_CONCEPTS_IMAGE_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define BOOST_GIL_CONCEPTS_IMAGE_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/basic.hpp&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/concept_check.hpp&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/fwd.hpp&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/image_view.hpp&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/point.hpp&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;boost/gil/detail/mp11.hpp&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#if defined(BOOST_CLANG)</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wunused-local-typedefs&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#if defined(BOOST_GCC) &amp;&amp; (BOOST_GCC &gt;= 40900)</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#pragma GCC diagnostic push</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#pragma GCC diagnostic ignored &quot;-Wunused-local-typedefs&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Image&gt;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_random_access_n_d_image_concept.html"> 56</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_random_access_n_d_image_concept.html">RandomAccessNDImageConcept</a></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;{</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; gil_function_requires&lt;Regular&lt;Image&gt;&gt;();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">using</span> view_t = <span class="keyword">typename</span> Image::view_t;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; gil_function_requires&lt;MutableRandomAccessNDImageViewConcept&lt;view_t&gt;&gt;();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">using</span> const_view_t = <span class="keyword">typename</span> Image::const_view_t;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">using</span> pixel_t = <span class="keyword">typename</span> Image::value_type;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">using</span> <a class="code" href="classboost_1_1gil_1_1point.html">point_t</a> = <span class="keyword">typename</span> Image::point_t;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; gil_function_requires&lt;PointNDConcept&lt;point_t&gt;&gt;();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; const_view_t cv = <a class="code" href="group___image_model.html#ga0505866ffb317dcd320e74be9874f950">const_view</a>(<a class="code" href="classboost_1_1gil_1_1image.html">image</a>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; ignore_unused_variable_warning(cv);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; view_t v = <a class="code" href="group___image_model.html#ga633557dbbff2d21c784b73412b47bb38">view</a>(<a class="code" href="classboost_1_1gil_1_1image.html">image</a>);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; ignore_unused_variable_warning(v);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; pixel_t fill_value;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="classboost_1_1gil_1_1point.html">point_t</a> pt = <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.dimensions();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; Image image1(pt);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; Image image2(pt, 1);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; Image image3(pt, fill_value, 1);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.recreate(pt);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.recreate(pt, 1);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.recreate(pt, fill_value, 1);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; Image <a class="code" href="classboost_1_1gil_1_1image.html">image</a>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;};</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Image&gt;</div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_random_access2_d_image_concept.html"> 108</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_random_access2_d_image_concept.html">RandomAccess2DImageConcept</a></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;{</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; gil_function_requires&lt;RandomAccessNDImageConcept&lt;Image&gt;&gt;();</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">using</span> x_coord_t = <span class="keyword">typename</span> Image::x_coord_t;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">using</span> y_coord_t = <span class="keyword">typename</span> Image::y_coord_t;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">using</span> value_t = <span class="keyword">typename</span> Image::value_type;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; gil_function_requires&lt;MutableRandomAccess2DImageViewConcept&lt;typename Image::view_t&gt;&gt;();</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; x_coord_t w=<a class="code" href="classboost_1_1gil_1_1image.html">image</a>.width();</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; y_coord_t h=<a class="code" href="classboost_1_1gil_1_1image.html">image</a>.height();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; value_t fill_value;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; Image im1(w,h);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; Image im2(w,h,1);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; Image im3(w,h,fill_value,1);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.recreate(w,h);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.recreate(w,h,1);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <a class="code" href="classboost_1_1gil_1_1image.html">image</a>.recreate(w,h,fill_value,1);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; Image <a class="code" href="classboost_1_1gil_1_1image.html">image</a>;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;};</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Image&gt;</div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_image_concept.html"> 143</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_image_concept.html">ImageConcept</a></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;{</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; {</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; gil_function_requires&lt;RandomAccess2DImageConcept&lt;Image&gt;&gt;();</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; gil_function_requires&lt;MutableImageViewConcept&lt;typename Image::view_t&gt;&gt;();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">using</span> coord_t = <span class="keyword">typename</span> Image::coord_t;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; static_assert(<a class="code" href="structboost_1_1gil_1_1num__channels.html">num_channels&lt;Image&gt;::value</a> == mp11::mp_size&lt;<span class="keyword">typename</span> color_space_type&lt;Image&gt;::type&gt;::value, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; static_assert(std::is_same&lt;coord_t, typename Image::x_coord_t&gt;::value, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; static_assert(std::is_same&lt;coord_t, typename Image::y_coord_t&gt;::value, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; Image <a class="code" href="classboost_1_1gil_1_1image.html">image</a>;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;};</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;}} <span class="comment">// namespace boost::gil</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="preprocessor">#if defined(BOOST_CLANG)</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="preprocessor">#if defined(BOOST_GCC) &amp;&amp; (BOOST_GCC &gt;= 40900)</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="preprocessor">#pragma GCC diagnostic pop</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structboost_1_1gil_1_1_random_access_n_d_image_concept_html"><div class="ttname"><a href="structboost_1_1gil_1_1_random_access_n_d_image_concept.html">boost::gil::RandomAccessNDImageConcept</a></div><div class="ttdoc">N-dimensional container of values.</div><div class="ttdef"><b>Definition:</b> concepts/image.hpp:56</div></div>
  51. <div class="ttc" id="structboost_1_1gil_1_1_image_concept_html"><div class="ttname"><a href="structboost_1_1gil_1_1_image_concept.html">boost::gil::ImageConcept</a></div><div class="ttdoc">2-dimensional image whose value type models PixelValueConcept</div><div class="ttdef"><b>Definition:</b> concepts/image.hpp:143</div></div>
  52. <div class="ttc" id="classboost_1_1gil_1_1image_html"><div class="ttname"><a href="classboost_1_1gil_1_1image.html">boost::gil::image</a></div><div class="ttdoc">container interface over image view. Models ImageConcept, PixelBasedConcept</div><div class="ttdef"><b>Definition:</b> image.hpp:40</div></div>
  53. <div class="ttc" id="structboost_1_1gil_1_1_random_access2_d_image_concept_html"><div class="ttname"><a href="structboost_1_1gil_1_1_random_access2_d_image_concept.html">boost::gil::RandomAccess2DImageConcept</a></div><div class="ttdoc">2-dimensional container of values</div><div class="ttdef"><b>Definition:</b> concepts/image.hpp:108</div></div>
  54. <div class="ttc" id="group___image_model_html_ga633557dbbff2d21c784b73412b47bb38"><div class="ttname"><a href="group___image_model.html#ga633557dbbff2d21c784b73412b47bb38">boost::gil::view</a></div><div class="ttdeci">const image&lt; Pixel, IsPlanar, Alloc &gt;::view_t &amp; view(image&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)</div><div class="ttdoc">Returns the non-constant-pixel view of an image.</div><div class="ttdef"><b>Definition:</b> image.hpp:443</div></div>
  55. <div class="ttc" id="group___image_model_html_ga0505866ffb317dcd320e74be9874f950"><div class="ttname"><a href="group___image_model.html#ga0505866ffb317dcd320e74be9874f950">boost::gil::const_view</a></div><div class="ttdeci">const image&lt; Pixel, IsPlanar, Alloc &gt;::const_view_t const_view(const image&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)</div><div class="ttdoc">Returns the constant-pixel view of an image.</div><div class="ttdef"><b>Definition:</b> image.hpp:447</div></div>
  56. <div class="ttc" id="structboost_1_1gil_1_1num__channels_html"><div class="ttname"><a href="structboost_1_1gil_1_1num__channels.html">boost::gil::num_channels</a></div><div class="ttdoc">Returns the number of channels of a pixel-based GIL construct.</div><div class="ttdef"><b>Definition:</b> locator.hpp:38</div></div>
  57. <div class="ttc" id="classboost_1_1gil_1_1point_html"><div class="ttname"><a href="classboost_1_1gil_1_1point.html">boost::gil::point&lt; std::ptrdiff_t &gt;</a></div></div>
  58. </div><!-- fragment --></div><!-- contents -->
  59. <!-- HTML footer for doxygen 1.8.13-->
  60. <!-- start footer part -->
  61. <hr class="footer"/>
  62. <address class="footer">
  63. <small>
  64. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  65. </small>
  66. </address>
  67. </body>
  68. </html>