ceph/src/boost/libs/gil/doc/html/g_i_l_0515.html

   1 <!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
   2
   3      Distributed under the Boost Software License, Version 1.0.
   4      (See accompanying file LICENSE_1_0.txt or copy at
   5      http://www.boost.org/LICENSE_1_0.txt)
   6   -->
   7
   8 <!--
   9     Copyright 2005-2007 Adobe Systems Incorporated
  10     Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
  11     or a copy at http://stlab.adobe.com/licenses.html)
  12
  13     Some files are held under additional license.
  14     Please see "http://stlab.adobe.com/licenses.html" for more information.
  15 -->
  16
  17 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  18         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  19 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
  20
  21 <head>
  22     <TITLE>Generic Image Library: nth_channel_deref_fn Struct Template Reference</TITLE>
  23     <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
  24     <LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
  25 </head>
  26 <body>
  27 <table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
  28 <td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
  29 <div class="qindex"><a class="qindex" href="index.html">Modules</a>
  30                   | <a class="qindex" href="classes.html">Alphabetical List</a>
  31                   | <a class="qindex" href="annotated.html">Class List</a>
  32                   | <a class="qindex" href="dirs.html">Directories</a>
  33                   | <a class="qindex" href="files.html">File List</a>
  34                   | <a class="qindex" href="../index.html">GIL Home Page</a>
  35 </div>
  36 <!-- End Header -->
  37 <!-- Generated by Doxygen 1.5.6 -->
  38   <div class="navpath"><a class="el" href="namespaceboost.html">boost</a>::<b>gil</b>::<b>detail</b>::<a class="el" href="g_i_l_0515.html">nth_channel_deref_fn</a>
  39   </div>
  40 <div class="contents">
  41 <h1>nth_channel_deref_fn Struct Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0186.html">Models</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::detail::nth_channel_deref_fn" --><code>#include &lt;<a class="el" href="g_i_l_0226.html">image_view_factory.hpp</a>&gt;</code>
  45 <p>
  46
  47 <p>
  48 <a href="g_i_l_0514.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  49 <h3>template&lt;typename SrcP&gt;<br>
  50  struct boost::gil::detail::nth_channel_deref_fn&lt; SrcP &gt;</h3>
  51
  52 Function object that returns a grayscale reference of the N-th channel of a given reference. Models: <a class="el" href="g_i_l_0350.html" title="Represents a unary function object that can be invoked upon dereferencing a pixel...">PixelDereferenceAdaptorConcept</a>.<p>
  53 If the input is a <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a> value or constant reference, the function object is immutable. Otherwise it is mutable (and returns non-const reference to the n-th channel). <table border="0" cellpadding="0" cellspacing="0">
  54 <tr><td></td></tr>
  55 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  56 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1909fca476c5798593a7ed34e7157fce"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::const_t" ref="1909fca476c5798593a7ed34e7157fce" args="" -->
  57 typedef <a class="el" href="g_i_l_0515.html">nth_channel_deref_fn</a><br>
  58 &lt; const_ref_t &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_t</b></td></tr>
  59
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c79ed995e6b4b1d8f459f0b37807e5cb"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::value_type" ref="c79ed995e6b4b1d8f459f0b37807e5cb" args="" -->
  61 typedef <a class="el" href="g_i_l_0606.html">pixel_value_type</a><br>
  62 &lt; channel_t, <a class="el" href="g_i_l_0567.html">gray_layout_t</a> &gt;<br>
  63 ::type&nbsp;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
  64
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="01ea77e6b19ce255f74eaa354e8cc6c1"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::const_reference" ref="01ea77e6b19ce255f74eaa354e8cc6c1" args="" -->
  66 typedef <a class="el" href="g_i_l_0604.html">pixel_reference_type</a><br>
  67 &lt; channel_t, <a class="el" href="g_i_l_0567.html">gray_layout_t</a>, <br>
  68 false, false &gt;::type&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
  69
  70 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ad6c059d39c24be9cddd1905995d23c"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::argument_type" ref="2ad6c059d39c24be9cddd1905995d23c" args="" -->
  71 typedef SrcP&nbsp;</td><td class="memItemRight" valign="bottom"><b>argument_type</b></td></tr>
  72
  73 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63a5fc94722c4fbdb03ed0ec51cd89c8"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::reference" ref="63a5fc94722c4fbdb03ed0ec51cd89c8" args="" -->
  74 typedef mpl::if_c&lt; is_mutable, <br>
  75 ref_t, <a class="el" href="g_i_l_0599.html">value_type</a> &gt;::type&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
  76
  77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe53618876958e2e15351c19804738f2"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::result_type" ref="fe53618876958e2e15351c19804738f2" args="" -->
  78 typedef reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>result_type</b></td></tr>
  79
  80 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f775f083d7bf091fec5c1a27680dc5c8"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::BOOST_STATIC_CONSTANT" ref="f775f083d7bf091fec5c1a27680dc5c8" args="(bool, is_mutable=pixel_is_reference&lt; SrcP &gt;::value &amp;&amp;pixel_reference_is_mutable&lt; SrcP &gt;::value)" -->
  82 &nbsp;</td><td class="memItemRight" valign="bottom"><b>BOOST_STATIC_CONSTANT</b> (bool, is_mutable=<a class="el" href="g_i_l_0600.html">pixel_is_reference</a>&lt; SrcP &gt;::value &amp;&amp;<a class="el" href="g_i_l_0602.html">pixel_reference_is_mutable</a>&lt; SrcP &gt;::value)</td></tr>
  83
  84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="addab96793b55b507de7b81ba1ddc280"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::nth_channel_deref_fn" ref="addab96793b55b507de7b81ba1ddc280" args="(int n=0)" -->
  85 &nbsp;</td><td class="memItemRight" valign="bottom"><b>nth_channel_deref_fn</b> (int n=0)</td></tr>
  86
  87 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="2030e999de9a2a28201d9bb8c1410835"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::nth_channel_deref_fn" ref="2030e999de9a2a28201d9bb8c1410835" args="(const nth_channel_deref_fn&lt; P &gt; &amp;d)" -->
  88 template&lt;typename P&gt; </td></tr>
  89 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>nth_channel_deref_fn</b> (const <a class="el" href="g_i_l_0515.html">nth_channel_deref_fn</a>&lt; P &gt; &amp;d)</td></tr>
  90
  91 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fbe164ea1c95ff0e87ef3deb8fea603"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::operator()" ref="3fbe164ea1c95ff0e87ef3deb8fea603" args="(argument_type srcP) const " -->
  92 result_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (argument_type srcP) const </td></tr>
  93
  94 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da0e3adfe5f3db62623fb73a49c120b3"></a><!-- doxytag: member="boost::gil::detail::nth_channel_deref_fn::_n" ref="da0e3adfe5f3db62623fb73a49c120b3" args="" -->
  96 int&nbsp;</td><td class="memItemRight" valign="bottom"><b>_n</b></td></tr>
  97
  98 </table>
  99 <hr>The documentation for this struct was generated from the following file:<ul>
 100 <li><a class="el" href="g_i_l_0226.html">image_view_factory.hpp</a></ul>
 101 </div>
 102 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
 103 <a href="http://www.doxygen.org/index.html">
 104 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 105 </body>
 106 </html>