libs/gil/doc/html/reference/group___scoped_channel_value.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: scoped_channel_value</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="#groups">Modules</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">scoped_channel_value<div class="ingroups"><a class="el" href="group___channel.html">Channel</a> &raquo; <a class="el" href="group___channel_model.html">Models</a></div></div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  50 Modules</h2></td></tr>
  51 <tr class="memitem:group___packed_channel_value_model"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___packed_channel_value_model.html">packed_channel_value</a></td></tr>
  52 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53 </table>
  54 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  55 <p>Traits for channels. Contains the following members: </p><div class="fragment"><div class="line"><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Channel&gt;</div><div class="line"><span class="keyword">struct </span>channel_traits {</div><div class="line">    <span class="keyword">using</span> value_type = ...;</div><div class="line">    <span class="keyword">using</span> reference = ...;</div><div class="line">    <span class="keyword">using</span> pointer = ...;</div><div class="line">    <span class="keyword">using</span> const_reference = ...;</div><div class="line">    <span class="keyword">using</span> const_pointer = ...;</div><div class="line"></div><div class="line">    <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> is_mutable;</div><div class="line">    <span class="keyword">static</span> value_type min_value();</div><div class="line">    <span class="keyword">static</span> value_type max_value();</div><div class="line">};</div></div><!-- fragment --><p>A channel adaptor that modifies the range of the source channel. Models: ChannelValueConcept</p>
  56 <p>Example: </p><div class="fragment"><div class="line"><span class="comment">// Create a double channel with range [-0.5 .. 0.5]</span></div><div class="line"><span class="keyword">struct </span>double_minus_half  { <span class="keyword">static</span> <span class="keywordtype">double</span> apply() { <span class="keywordflow">return</span> -0.5; } };</div><div class="line"><span class="keyword">struct </span>double_plus_half   { <span class="keyword">static</span> <span class="keywordtype">double</span> apply() { <span class="keywordflow">return</span>  0.5; } };</div><div class="line"><span class="keyword">using</span> bits64custom_t = scoped_channel_value&lt;double, double_minus_half, double_plus_half&gt;;</div><div class="line"></div><div class="line"><span class="comment">// channel_convert its maximum should map to the maximum</span></div><div class="line">bits64custom_t x = channel_traits&lt;bits64custom_t&gt;::max_value();</div><div class="line">assert(x == 0.5);</div><div class="line">uint16_t y = channel_convert&lt;uint16_t&gt;(x);</div><div class="line">assert(y == 65535);</div></div><!-- fragment --> </div><!-- contents -->
  57      <!-- HTML footer for doxygen 1.8.13-->
  58      <!-- start footer part -->
  59      <hr class="footer"/>
  60      <address class="footer">
  61       <small>
  62         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  63       </small>
  64     </address>
  65   </body>
  66 </html>