libs/gil/doc/html/reference/structboost_1_1gil_1_1pixel.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: pixel&lt; ChannelValue, Layout &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_1pixel.html">pixel</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-static-attribs">Static Public Attributes</a> &#124;
  50 <a href="structboost_1_1gil_1_1pixel-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">pixel&lt; ChannelValue, Layout &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel.html">Pixel</a> &raquo; <a class="el" href="group___pixel_model.html">Models</a> &raquo; <a class="el" href="group___pixel_model_pixel.html">pixel</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_pixel.html">pixel</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>Represents a pixel value (a container of channels). Models: <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_value_concept.html" title="Homogeneous color base that also has a default constructor. Refines Regular.">HomogeneousColorBaseValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_value_concept.html" title="Pixel concept that is a Regular type.">PixelValueConcept</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>.
  57  <a href="structboost_1_1gil_1_1pixel.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="pixel_8hpp_source.html">pixel.hpp</a>&gt;</code></p>
  60
  61 <p>Inherits 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:a41e636d5aab49f830310d96cc20a62e4"><td class="memItemLeft" align="right" valign="top"><a id="a41e636d5aab49f830310d96cc20a62e4"></a>
  66 using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a>&lt; ChannelValue, Layout &gt;</td></tr>
  67 <tr class="separator:a41e636d5aab49f830310d96cc20a62e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:a74202cdd96628bc49a756e5fc87d22de"><td class="memItemLeft" align="right" valign="top"><a id="a74202cdd96628bc49a756e5fc87d22de"></a>
  69 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">value_type</a> &amp;</td></tr>
  70 <tr class="separator:a74202cdd96628bc49a756e5fc87d22de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a4780295ff953151e0121aebfbcade4da"><td class="memItemLeft" align="right" valign="top"><a id="a4780295ff953151e0121aebfbcade4da"></a>
  72 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_reference</b> = <a class="el" href="structboost_1_1gil_1_1pixel.html">value_type</a> const  &amp;</td></tr>
  73 <tr class="separator:a4780295ff953151e0121aebfbcade4da"><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:a39970d76708fe02233e30494f8bfcc08"><td class="memItemLeft" align="right" valign="top"><a id="a39970d76708fe02233e30494f8bfcc08"></a>
  78 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v)</td></tr>
  79 <tr class="separator:a39970d76708fe02233e30494f8bfcc08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:ac8fc3a7aa3c2eb33c5647adba7154a10"><td class="memItemLeft" align="right" valign="top"><a id="ac8fc3a7aa3c2eb33c5647adba7154a10"></a>
  81 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1)</td></tr>
  82 <tr class="separator:ac8fc3a7aa3c2eb33c5647adba7154a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:a8de9c605ecf5e105d983af12e4753a02"><td class="memItemLeft" align="right" valign="top"><a id="a8de9c605ecf5e105d983af12e4753a02"></a>
  84 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2)</td></tr>
  85 <tr class="separator:a8de9c605ecf5e105d983af12e4753a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a1ebaaeee8a7a4befe3fbcc208c08d51c"><td class="memItemLeft" align="right" valign="top"><a id="a1ebaaeee8a7a4befe3fbcc208c08d51c"></a>
  87 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2, channel_t v3)</td></tr>
  88 <tr class="separator:a1ebaaeee8a7a4befe3fbcc208c08d51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a91df320aa55ea9139d70ebe7ace80c14"><td class="memItemLeft" align="right" valign="top"><a id="a91df320aa55ea9139d70ebe7ace80c14"></a>
  90 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2, channel_t v3, channel_t v4)</td></tr>
  91 <tr class="separator:a91df320aa55ea9139d70ebe7ace80c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:aaed63e339592d8e9cfd284c62fcee905"><td class="memItemLeft" align="right" valign="top"><a id="aaed63e339592d8e9cfd284c62fcee905"></a>
  93 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (channel_t v0, channel_t v1, channel_t v2, channel_t v3, channel_t v4, channel_t v5)</td></tr>
  94 <tr class="separator:aaed63e339592d8e9cfd284c62fcee905"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 <tr class="memitem:a3539e565edb5b6575daba03680ff5015"><td class="memItemLeft" align="right" valign="top"><a id="a3539e565edb5b6575daba03680ff5015"></a>
  96 &#160;</td><td class="memItemRight" valign="bottom"><b>pixel</b> (const <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> &amp;p)</td></tr>
  97 <tr class="separator:a3539e565edb5b6575daba03680ff5015"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:a4849aa68983b39057adf8fe94ef0deda"><td class="memItemLeft" align="right" valign="top"><a id="a4849aa68983b39057adf8fe94ef0deda"></a>
  99 <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> const &amp;p)</td></tr>
 100 <tr class="separator:a4849aa68983b39057adf8fe94ef0deda"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 <tr class="memitem:a61332efa3f596341a1a36170c71033da"><td class="memTemplParams" colspan="2"><a id="a61332efa3f596341a1a36170c71033da"></a>
 102 template&lt;typename Pixel &gt; </td></tr>
 103 <tr class="memitem:a61332efa3f596341a1a36170c71033da"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>pixel</b> (Pixel const &amp;p, typename std::enable_if&lt; is_pixel&lt; Pixel &gt;::value &gt;::type *=nullptr)</td></tr>
 104 <tr class="separator:a61332efa3f596341a1a36170c71033da"><td class="memSeparator" colspan="2">&#160;</td></tr>
 105 <tr class="memitem:a8fcd25c0c4f35f446588e58239d48cb9"><td class="memTemplParams" colspan="2"><a id="a8fcd25c0c4f35f446588e58239d48cb9"></a>
 106 template&lt;typename Pixel &gt; </td></tr>
 107 <tr class="memitem:a8fcd25c0c4f35f446588e58239d48cb9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (Pixel const &amp;p)</td></tr>
 108 <tr class="separator:a8fcd25c0c4f35f446588e58239d48cb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 109 <tr class="memitem:a2ee168419936700a6db322af16b6fa56"><td class="memTemplParams" colspan="2"><a id="a2ee168419936700a6db322af16b6fa56"></a>
 110 template&lt;typename Pixel &gt; </td></tr>
 111 <tr class="memitem:a2ee168419936700a6db322af16b6fa56"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator==</b> (Pixel const &amp;p) const</td></tr>
 112 <tr class="separator:a2ee168419936700a6db322af16b6fa56"><td class="memSeparator" colspan="2">&#160;</td></tr>
 113 <tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplParams" colspan="2"><a id="a7e84b33a61c27a8ca0d4cfd1d17a3ce7"></a>
 114 template&lt;typename Pixel &gt; </td></tr>
 115 <tr class="memitem:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator!=</b> (Pixel const &amp;p) const</td></tr>
 116 <tr class="separator:a7e84b33a61c27a8ca0d4cfd1d17a3ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 <tr class="memitem:a3d0584a160b08831c9c683660767942d"><td class="memItemLeft" align="right" valign="top"><a id="a3d0584a160b08831c9c683660767942d"></a>
 118 auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (std::size_t index) -&gt; typename channel_traits&lt; channel_t &gt;::<a class="el" href="structboost_1_1gil_1_1pixel.html">reference</a></td></tr>
 119 <tr class="separator:a3d0584a160b08831c9c683660767942d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 <tr class="memitem:a9c00c22fbadf618113641d4713b35d5d"><td class="memItemLeft" align="right" valign="top"><a id="a9c00c22fbadf618113641d4713b35d5d"></a>
 121 auto&#160;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (std::size_t index) const -&gt; typename channel_traits&lt; channel_t &gt;::const_reference</td></tr>
 122 <tr class="separator:a9c00c22fbadf618113641d4713b35d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:a46c6aa36b578455e7808aa0342d29142"><td class="memItemLeft" align="right" valign="top"><a id="a46c6aa36b578455e7808aa0342d29142"></a>
 124 <a class="el" href="structboost_1_1gil_1_1pixel.html">pixel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (channel_t channel)</td></tr>
 125 <tr class="separator:a46c6aa36b578455e7808aa0342d29142"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:a0459b5c8b1d192e54f0aa451d89dce42"><td class="memItemLeft" align="right" valign="top"><a id="a0459b5c8b1d192e54f0aa451d89dce42"></a>
 127 bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (channel_t channel) const</td></tr>
 128 <tr class="separator:a0459b5c8b1d192e54f0aa451d89dce42"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 </table><table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
 131 Static Public Attributes</h2></td></tr>
 132 <tr class="memitem:ada04709db53ded2c170444a3f1c4e5d4"><td class="memItemLeft" align="right" valign="top"><a id="ada04709db53ded2c170444a3f1c4e5d4"></a>
 133 static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_mutable</b> = channel_traits&lt;channel_t&gt;::is_mutable</td></tr>
 134 <tr class="separator:ada04709db53ded2c170444a3f1c4e5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 </table>
 136 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 137 <div class="textblock"><h3>template&lt;typename ChannelValue, typename Layout&gt;<br />
 138 struct boost::gil::pixel&lt; ChannelValue, Layout &gt;</h3>
 139
 140 <p>Represents a pixel value (a container of channels). Models: <a class="el" href="structboost_1_1gil_1_1_homogeneous_color_base_value_concept.html" title="Homogeneous color base that also has a default constructor. Refines Regular.">HomogeneousColorBaseValueConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_value_concept.html" title="Pixel concept that is a Regular type.">PixelValueConcept</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>. </p>
 141 <p>A pixel is a set of channels defining the color at a given point in an image. Conceptually, a pixel is little more than a color base whose elements model <code><a class="el" href="structboost_1_1gil_1_1_channel_concept.html" title="A channel is the building block of a color. Color is defined as a mixture of primary colors and a cha...">ChannelConcept</a></code>. The class <code>pixel</code> defines a simple, homogeneous pixel value. It is used to store the value of a color. The built-in C++ references to <code>pixel</code>, <code>pixel&amp;</code> and <code>const</code> <code>pixel&amp;</code> are used to represent a reference to a pixel inside an interleaved image view (a view in which all channels are together in memory). Similarly, built-in pointer types <code>pixel*</code> and <code>const</code> <code>pixel*</code> are used as the standard iterator over a row of interleaved homogeneous pixels.</p>
 142 <p>Since <code>pixel</code> inherits the properties of color base, assigning, equality comparison and copy-construcion are allowed between compatible pixels. This means that an 8-bit RGB pixel may be assigned to an 8-bit BGR pixel, or to an 8-bit planar reference. The channels are properly paired semantically.</p>
 143 <p>The single-channel (grayscale) instantiation of the class pixel, (i.e. <code>pixel&lt;T,gray_layout_t&gt;</code>) is also convertible to/from a channel value. This allows grayscale pixels to be used in simpler expressions like *gray_pix1 = *gray_pix2 instead of more complicated at_c&lt;0&gt;(gray_pix1) = at_c&lt;0&gt;(gray_pix2) or get_color&lt;gray_color_t&gt;(gray_pix1) = get_color&lt;gray_color_t&gt;(gray_pix2)</p>
 144 <dl class="tparams"><dt>Template Parameters</dt><dd>
 145   <table class="tparams">
 146     <tr><td class="paramname">ChannelValue</td><td>TODO </td></tr>
 147     <tr><td class="paramname">Layout</td><td>mp11::make_integer_sequence&lt;int, ColorSpace::size&gt; </td></tr>
 148   </table>
 149   </dd>
 150 </dl>
 151 </div><hr/>The documentation for this struct was generated from the following files:<ul>
 152 <li><a class="el" href="metafunctions_8hpp_source.html">metafunctions.hpp</a></li>
 153 <li><a class="el" href="pixel_8hpp_source.html">pixel.hpp</a></li>
 154 </ul>
 155 </div><!-- contents -->
 156      <!-- HTML footer for doxygen 1.8.13-->
 157      <!-- start footer part -->
 158      <hr class="footer"/>
 159      <address class="footer">
 160       <small>
 161         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 162       </small>
 163     </address>
 164   </body>
 165 </html>