libs/gil/doc/html/reference/classboost_1_1gil_1_1image.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: image&lt; Pixel, IsPlanar, Alloc &gt; Class 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="classboost_1_1gil_1_1image.html">image</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="#pub-attribs">Public Attributes</a> &#124;
  50 <a href="classboost_1_1gil_1_1image-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">image&lt; Pixel, IsPlanar, Alloc &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___image.html">Image</a> &raquo; <a class="el" href="group___image_model.html">Models</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>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>
  57  <a href="classboost_1_1gil_1_1image.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="image_8hpp_source.html">image.hpp</a>&gt;</code></p>
  60 <table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  62 Public Types</h2></td></tr>
  63 <tr class="memitem:a3638c9d581a358b25c4f675367ce023f"><td class="memItemLeft" align="right" valign="top"><a id="a3638c9d581a358b25c4f675367ce023f"></a>
  64 using&#160;</td><td class="memItemRight" valign="bottom"><b>allocator_type</b> = typename std::allocator_traits&lt; Alloc &gt;::template rebind_alloc&lt; unsigned char &gt;</td></tr>
  65 <tr class="separator:a3638c9d581a358b25c4f675367ce023f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:a036604f03e8badb4465c65270d8e3d22"><td class="memItemLeft" align="right" valign="top"><a id="a036604f03e8badb4465c65270d8e3d22"></a>
  67 using&#160;</td><td class="memItemRight" valign="bottom"><b>view_t</b> = typename <a class="el" href="structboost_1_1gil_1_1view__type__from__pixel.html">view_type_from_pixel</a>&lt; Pixel, IsPlanar &gt;::type</td></tr>
  68 <tr class="separator:a036604f03e8badb4465c65270d8e3d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:af22de4cd1c084c288216682b1a04416a"><td class="memItemLeft" align="right" valign="top"><a id="af22de4cd1c084c288216682b1a04416a"></a>
  70 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_view_t</b> = typename view_t::const_t</td></tr>
  71 <tr class="separator:af22de4cd1c084c288216682b1a04416a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:adfe36fdedc6e90f870ef4fd0bf18b22a"><td class="memItemLeft" align="right" valign="top"><a id="adfe36fdedc6e90f870ef4fd0bf18b22a"></a>
  73 using&#160;</td><td class="memItemRight" valign="bottom"><b>point_t</b> = typename view_t::point_t</td></tr>
  74 <tr class="separator:adfe36fdedc6e90f870ef4fd0bf18b22a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:a568300af26fec4a23b5f280209f1ad14"><td class="memItemLeft" align="right" valign="top"><a id="a568300af26fec4a23b5f280209f1ad14"></a>
  76 using&#160;</td><td class="memItemRight" valign="bottom"><b>coord_t</b> = typename view_t::coord_t</td></tr>
  77 <tr class="separator:a568300af26fec4a23b5f280209f1ad14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:a470418f083aa6040ac1983dc22e94d76"><td class="memItemLeft" align="right" valign="top"><a id="a470418f083aa6040ac1983dc22e94d76"></a>
  79 using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = typename view_t::value_type</td></tr>
  80 <tr class="separator:a470418f083aa6040ac1983dc22e94d76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:a7e1d4e6abecb43f99a7d66c8479f15c3"><td class="memItemLeft" align="right" valign="top"><a id="a7e1d4e6abecb43f99a7d66c8479f15c3"></a>
  82 using&#160;</td><td class="memItemRight" valign="bottom"><b>x_coord_t</b> = coord_t</td></tr>
  83 <tr class="separator:a7e1d4e6abecb43f99a7d66c8479f15c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:ab2c71b4976bdece620245109800e843f"><td class="memItemLeft" align="right" valign="top"><a id="ab2c71b4976bdece620245109800e843f"></a>
  85 using&#160;</td><td class="memItemRight" valign="bottom"><b>y_coord_t</b> = coord_t</td></tr>
  86 <tr class="separator:ab2c71b4976bdece620245109800e843f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table><table class="memberdecls">
  88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  89 Public Member Functions</h2></td></tr>
  90 <tr class="memitem:acc6bd43721b3ef663442e17e1b8fb760"><td class="memItemLeft" align="right" valign="top"><a id="acc6bd43721b3ef663442e17e1b8fb760"></a>
  91 const point_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const</td></tr>
  92 <tr class="separator:acc6bd43721b3ef663442e17e1b8fb760"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 <tr class="memitem:add9c490d2545adf2d1f85b84958c167c"><td class="memItemLeft" align="right" valign="top"><a id="add9c490d2545adf2d1f85b84958c167c"></a>
  94 x_coord_t&#160;</td><td class="memItemRight" valign="bottom"><b>width</b> () const</td></tr>
  95 <tr class="separator:add9c490d2545adf2d1f85b84958c167c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memItemLeft" align="right" valign="top"><a id="a7dd7e3c9d94dc1ab42b6d04b39ab1201"></a>
  97 y_coord_t&#160;</td><td class="memItemRight" valign="bottom"><b>height</b> () const</td></tr>
  98 <tr class="separator:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 <tr class="memitem:aceab6688d7bdc71b3118c91b81e39a7f"><td class="memItemLeft" align="right" valign="top"><a id="aceab6688d7bdc71b3118c91b81e39a7f"></a>
 100 &#160;</td><td class="memItemRight" valign="bottom"><b>image</b> (std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
 101 <tr class="separator:aceab6688d7bdc71b3118c91b81e39a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 <tr class="memitem:ad20ce07917c6be964611e2ab87fee52b"><td class="memItemLeft" align="right" valign="top"><a id="ad20ce07917c6be964611e2ab87fee52b"></a>
 103 &#160;</td><td class="memItemRight" valign="bottom"><b>image</b> (const point_t &amp;dimensions, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
 104 <tr class="separator:ad20ce07917c6be964611e2ab87fee52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 105 <tr class="memitem:a348f4a910ac7d4e217b163874c9f12fd"><td class="memItemLeft" align="right" valign="top"><a id="a348f4a910ac7d4e217b163874c9f12fd"></a>
 106 &#160;</td><td class="memItemRight" valign="bottom"><b>image</b> (x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
 107 <tr class="separator:a348f4a910ac7d4e217b163874c9f12fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:a9dffedcc688a0c662608dfb3eff21e1b"><td class="memItemLeft" align="right" valign="top"><a id="a9dffedcc688a0c662608dfb3eff21e1b"></a>
 109 &#160;</td><td class="memItemRight" valign="bottom"><b>image</b> (const point_t &amp;dimensions, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in=Alloc())</td></tr>
 110 <tr class="separator:a9dffedcc688a0c662608dfb3eff21e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 <tr class="memitem:ab2338d4efa4194f32afa2778c00d5c84"><td class="memItemLeft" align="right" valign="top"><a id="ab2338d4efa4194f32afa2778c00d5c84"></a>
 112 &#160;</td><td class="memItemRight" valign="bottom"><b>image</b> (x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment=0, const Alloc alloc_in=Alloc())</td></tr>
 113 <tr class="separator:ab2338d4efa4194f32afa2778c00d5c84"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <tr class="memitem:a83f7f90e51d5d2fc0596f53dc1e13d74"><td class="memItemLeft" align="right" valign="top"><a id="a83f7f90e51d5d2fc0596f53dc1e13d74"></a>
 115 &#160;</td><td class="memItemRight" valign="bottom"><b>image</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a> &amp;img)</td></tr>
 116 <tr class="separator:a83f7f90e51d5d2fc0596f53dc1e13d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 <tr class="memitem:a6d6ac2d80d5065dceff2137d5b2a6ea8"><td class="memTemplParams" colspan="2"><a id="a6d6ac2d80d5065dceff2137d5b2a6ea8"></a>
 118 template&lt;typename P2 , bool IP2, typename Alloc2 &gt; </td></tr>
 119 <tr class="memitem:a6d6ac2d80d5065dceff2137d5b2a6ea8"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>image</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a>&lt; P2, IP2, Alloc2 &gt; &amp;img)</td></tr>
 120 <tr class="separator:a6d6ac2d80d5065dceff2137d5b2a6ea8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:a5948ad79aad69674db60be93cd194766"><td class="memItemLeft" align="right" valign="top"><a id="a5948ad79aad69674db60be93cd194766"></a>
 122 <a class="el" href="classboost_1_1gil_1_1image.html">image</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1gil_1_1image.html">image</a> &amp;img)</td></tr>
 123 <tr class="separator:a5948ad79aad69674db60be93cd194766"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:ac3f3eb7c7e02bd538fa830c35fe97f6a"><td class="memTemplParams" colspan="2"><a id="ac3f3eb7c7e02bd538fa830c35fe97f6a"></a>
 125 template&lt;typename Img &gt; </td></tr>
 126 <tr class="memitem:ac3f3eb7c7e02bd538fa830c35fe97f6a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1image.html">image</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const Img &amp;img)</td></tr>
 127 <tr class="separator:ac3f3eb7c7e02bd538fa830c35fe97f6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:a82dff19823db9c80dc337f1d6fc98620"><td class="memItemLeft" align="right" valign="top"><a id="a82dff19823db9c80dc337f1d6fc98620"></a>
 129 Alloc &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>allocator</b> ()</td></tr>
 130 <tr class="separator:a82dff19823db9c80dc337f1d6fc98620"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:a8ab00914b88409279388716365522af9"><td class="memItemLeft" align="right" valign="top"><a id="a8ab00914b88409279388716365522af9"></a>
 132 Alloc const  &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>allocator</b> () const</td></tr>
 133 <tr class="separator:a8ab00914b88409279388716365522af9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:aecbe6d01103834f8178f73465a19d58c"><td class="memItemLeft" align="right" valign="top"><a id="aecbe6d01103834f8178f73465a19d58c"></a>
 135 void&#160;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classboost_1_1gil_1_1image.html">image</a> &amp;img)</td></tr>
 136 <tr class="separator:aecbe6d01103834f8178f73465a19d58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:aaa5e9d00645607b9d19ab7759906c008"><td class="memItemLeft" align="right" valign="top"><a id="aaa5e9d00645607b9d19ab7759906c008"></a>
 138 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &amp;dims, std::size_t alignment=0)</td></tr>
 139 <tr class="separator:aaa5e9d00645607b9d19ab7759906c008"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a89c3892dbcc482526ac4fd6a6a045cdb"><td class="memItemLeft" align="right" valign="top"><a id="a89c3892dbcc482526ac4fd6a6a045cdb"></a>
 141 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, std::size_t alignment=0)</td></tr>
 142 <tr class="separator:a89c3892dbcc482526ac4fd6a6a045cdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a30a1cc855b2419cb00ef5ebe35b2e43a"><td class="memItemLeft" align="right" valign="top"><a id="a30a1cc855b2419cb00ef5ebe35b2e43a"></a>
 144 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &amp;dims, const Pixel &amp;p_in, std::size_t alignment=0)</td></tr>
 145 <tr class="separator:a30a1cc855b2419cb00ef5ebe35b2e43a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:aeab1806c92d01e28d9438aefaaf7b9ff"><td class="memItemLeft" align="right" valign="top"><a id="aeab1806c92d01e28d9438aefaaf7b9ff"></a>
 147 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment=0)</td></tr>
 148 <tr class="separator:aeab1806c92d01e28d9438aefaaf7b9ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:ab697a973cba2c84716ddbd587bab91ec"><td class="memItemLeft" align="right" valign="top"><a id="ab697a973cba2c84716ddbd587bab91ec"></a>
 150 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &amp;dims, std::size_t alignment, const Alloc alloc_in)</td></tr>
 151 <tr class="separator:ab697a973cba2c84716ddbd587bab91ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a24624398dfcd12e2a9fb445a6dc6f053"><td class="memItemLeft" align="right" valign="top"><a id="a24624398dfcd12e2a9fb445a6dc6f053"></a>
 153 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, std::size_t alignment, const Alloc alloc_in)</td></tr>
 154 <tr class="separator:a24624398dfcd12e2a9fb445a6dc6f053"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:aa4ea3606ec6084a66c3d8a68d5d92c93"><td class="memItemLeft" align="right" valign="top"><a id="aa4ea3606ec6084a66c3d8a68d5d92c93"></a>
 156 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const point_t &amp;dims, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in)</td></tr>
 157 <tr class="separator:aa4ea3606ec6084a66c3d8a68d5d92c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:a887ee56b29eff6cd896cecd30b957a91"><td class="memItemLeft" align="right" valign="top"><a id="a887ee56b29eff6cd896cecd30b957a91"></a>
 159 void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, const Pixel &amp;p_in, std::size_t alignment, const Alloc alloc_in)</td></tr>
 160 <tr class="separator:a887ee56b29eff6cd896cecd30b957a91"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 </table><table class="memberdecls">
 162 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 163 Public Attributes</h2></td></tr>
 164 <tr class="memitem:af0b0c4c1267ee1f0ec635a4b2d00ec98"><td class="memItemLeft" align="right" valign="top"><a id="af0b0c4c1267ee1f0ec635a4b2d00ec98"></a>
 165 view_t&#160;</td><td class="memItemRight" valign="bottom"><b>_view</b></td></tr>
 166 <tr class="separator:af0b0c4c1267ee1f0ec635a4b2d00ec98"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 </table>
 168 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 169 <div class="textblock"><h3>template&lt;typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator&lt;unsigned char&gt;&gt;<br />
 170 class boost::gil::image&lt; Pixel, IsPlanar, Alloc &gt;</h3>
 171
 172 <p>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> </p>
 173 <p>A 2D container whose elements are pixels. It is templated over the pixel type, a boolean indicating whether it should be planar, and an optional allocator.</p>
 174 <p>Note that its element type does not have to be a pixel. <code>image</code> can be instantiated with any <a class="el" href="structboost_1_1gil_1_1_regular.html" title="Concept for type regularity requirement.">Regular</a> element, in which case it models the weaker <a class="el" href="structboost_1_1gil_1_1_random_access2_d_image_concept.html" title="2-dimensional container of values">RandomAccess2DImageConcept</a> and does not model <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a></p>
 175 <p>When recreating an image of the same or smaller size the memory will be reused if possible. </p>
 176 </div><hr/>The documentation for this class was generated from the following file:<ul>
 177 <li><a class="el" href="image_8hpp_source.html">image.hpp</a></li>
 178 </ul>
 179 </div><!-- contents -->
 180      <!-- HTML footer for doxygen 1.8.13-->
 181      <!-- start footer part -->
 182      <hr class="footer"/>
 183      <address class="footer">
 184       <small>
 185         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 186       </small>
 187     </address>
 188   </body>
 189 </html>