2
0
mirror of https://github.com/boostorg/gil.git synced 2026-01-27 06:52:11 +00:00
Files
gil/develop/doc/html/reference/channel_8hpp.html

181 lines
19 KiB
HTML

<!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
-->
<!--
Copyright 2005-2007 Adobe Systems Incorporated
Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
or a copy at http://stlab.adobe.com/licenses.html)
Some files are held under additional license.
Please see "http://stlab.adobe.com/licenses.html" for more information.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<TITLE>channel.hpp File Reference</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
<link type="text/css" rel="stylesheet" href="../_static/style.css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div class="header">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
<tr>
<td valign="top" width="300">
<h3><a href="../index.html"><img
alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
</td>
<td >
<h1 align="center"><a href="../index.html"></a></h1>
</td>
<td>
</td>
</tr>
</table>
</div>
<hr/>
<table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
<td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
<div class="qindex"><a class="qindex" href="index.html">Modules</a>
| <a class="qindex" href="classes.html">Alphabetical List</a>
| <a class="qindex" href="annotated.html">Class List</a>
</div>
<!-- End Header -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="nav-path" class="navpath">
<ul>
<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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">channel.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Channel utilities.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;limits&gt;</code><br/>
<code>#include &lt;cassert&gt;</code><br/>
<code>#include &lt;boost/cstdint.hpp&gt;</code><br/>
<code>#include &lt;boost/config.hpp&gt;</code><br/>
<code>#include &lt;boost/integer/integer_mask.hpp&gt;</code><br/>
<code>#include &lt;boost/type_traits/remove_cv.hpp&gt;</code><br/>
<code>#include &quot;<a class="el" href="gil__config_8hpp_source.html">gil_config.hpp</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="utilities_8hpp_source.html">utilities.hpp</a>&quot;</code><br/>
</div>
<p><a href="channel_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1channel__traits.html">channel_traits&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Traits for channels. Contains the following members: <a href="structboost_1_1gil_1_1channel__traits.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1scoped__channel__value.html">scoped_channel_value&lt; BaseChannelValue, MinVal, MaxVal &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A channel adaptor that modifies the range of the source channel. Models: <a class="el" href="structboost_1_1gil_1_1_channel_value_concept.html" title="A channel that supports default construction. ">ChannelValueConcept</a>. <a href="structboost_1_1gil_1_1scoped__channel__value.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__channel__value.html">packed_channel_value&lt; NumBits &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value of a subbyte channel. Models: <a class="el" href="structboost_1_1gil_1_1_channel_value_concept.html" title="A channel that supports default construction. ">ChannelValueConcept</a>. <a href="classboost_1_1gil_1_1packed__channel__value.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01false_01_4.html">packed_channel_reference&lt; BitField, FirstBit, NumBits, false &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constant subbyte channel reference whose bit offset is fixed at compile time. Models <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>. <a href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01false_01_4.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01true_01_4.html">packed_channel_reference&lt; BitField, FirstBit, NumBits, true &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A mutable subbyte channel reference whose bit offset is fixed at compile time. Models <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>. <a href="classboost_1_1gil_1_1packed__channel__reference_3_01_bit_field_00_01_first_bit_00_01_num_bits_00_01true_01_4.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01false_01_4.html">packed_dynamic_channel_reference&lt; BitField, NumBits, false &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Models a constant subbyte channel reference whose bit offset is a runtime parameter. Models <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> Same as packed_channel_reference, except that the offset is a runtime parameter. <a href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01false_01_4.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01true_01_4.html">packed_dynamic_channel_reference&lt; BitField, NumBits, true &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Models a mutable subbyte channel reference whose bit offset is a runtime parameter. Models <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> Same as packed_channel_reference, except that the offset is a runtime parameter. <a href="classboost_1_1gil_1_1packed__dynamic__channel__reference_3_01_bit_field_00_01_num_bits_00_01true_01_4.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceboost"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost.html">boost</a></td></tr>
<tr class="memdesc:namespaceboost"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pixel 2D LOCATOR. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga7baf69eea57892aef15823b0339a7a13"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7baf69eea57892aef15823b0339a7a13"></a>
typedef uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>bits8</b></td></tr>
<tr class="separator:ga7baf69eea57892aef15823b0339a7a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8674e88e0ffba62c485fa7213c897bc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf8674e88e0ffba62c485fa7213c897bc"></a>
typedef uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>bits16</b></td></tr>
<tr class="separator:gaf8674e88e0ffba62c485fa7213c897bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78a76ea1fc2025b67d93c32bf5f0d108"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga78a76ea1fc2025b67d93c32bf5f0d108"></a>
typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bits32</b></td></tr>
<tr class="separator:ga78a76ea1fc2025b67d93c32bf5f0d108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabac6e224fbcb609ee77dc80fa3a21823"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabac6e224fbcb609ee77dc80fa3a21823"></a>
typedef int8_t&#160;</td><td class="memItemRight" valign="bottom"><b>bits8s</b></td></tr>
<tr class="separator:gabac6e224fbcb609ee77dc80fa3a21823"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf9d153286580c8f5c0fc6a3707c20a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaf9d153286580c8f5c0fc6a3707c20a6"></a>
typedef int16_t&#160;</td><td class="memItemRight" valign="bottom"><b>bits16s</b></td></tr>
<tr class="separator:gaaf9d153286580c8f5c0fc6a3707c20a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7fa01f32e1d2d1d17b3a15c01fd3780"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf7fa01f32e1d2d1d17b3a15c01fd3780"></a>
typedef int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>bits32s</b></td></tr>
<tr class="separator:gaf7fa01f32e1d2d1d17b3a15c01fd3780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59ce39e260cc83516fa743cd8ba55aa7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga59ce39e260cc83516fa743cd8ba55aa7"></a>
typedef scoped_channel_value<br class="typebreak"/>
&lt; float, float_zero, float_one &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>bits32f</b></td></tr>
<tr class="separator:ga59ce39e260cc83516fa743cd8ba55aa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaa0bd7927a859ab0e44df1df898b68e7c"></a>
template&lt;typename BF , int FB, int NB, bool M, typename R &gt; </td></tr>
<tr class="memitem:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#gaa0bd7927a859ab0e44df1df898b68e7c">swap</a> (const boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; x, R &amp;y)</td></tr>
<tr class="memdesc:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
<tr class="separator:gaa0bd7927a859ab0e44df1df898b68e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaad704056496a9a216609ebde22497e5f"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaad704056496a9a216609ebde22497e5f"></a>
template&lt;typename BF , int FB, int NB, bool M&gt; </td></tr>
<tr class="memitem:gaad704056496a9a216609ebde22497e5f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#gaad704056496a9a216609ebde22497e5f">swap</a> (typename boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt;::value_type &amp;x, const boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; y)</td></tr>
<tr class="memdesc:gaad704056496a9a216609ebde22497e5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
<tr class="separator:gaad704056496a9a216609ebde22497e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga8dd3a59fa9f04ce822b13f268f8a1ed4"></a>
template&lt;typename BF , int FB, int NB, bool M&gt; </td></tr>
<tr class="memitem:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_reference_model.html#ga8dd3a59fa9f04ce822b13f268f8a1ed4">swap</a> (const boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; x, const boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; y)</td></tr>
<tr class="memdesc:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_channel_reference <br/></td></tr>
<tr class="separator:ga8dd3a59fa9f04ce822b13f268f8a1ed4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga787db0870b8b34244289b895ed8345e2"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga787db0870b8b34244289b895ed8345e2"></a>
template&lt;typename BF , int NB, bool M, typename R &gt; </td></tr>
<tr class="memitem:ga787db0870b8b34244289b895ed8345e2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_dynamic_reference_model.html#ga787db0870b8b34244289b895ed8345e2">swap</a> (const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; x, R &amp;y)</td></tr>
<tr class="memdesc:ga787db0870b8b34244289b895ed8345e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br/></td></tr>
<tr class="separator:ga787db0870b8b34244289b895ed8345e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7ea281b0cce57c44a9046f732e4112b"><td class="memTemplParams" colspan="2"><a class="anchor" id="gab7ea281b0cce57c44a9046f732e4112b"></a>
template&lt;typename BF , int NB, bool M&gt; </td></tr>
<tr class="memitem:gab7ea281b0cce57c44a9046f732e4112b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_dynamic_reference_model.html#gab7ea281b0cce57c44a9046f732e4112b">swap</a> (typename boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt;::value_type &amp;x, const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; y)</td></tr>
<tr class="memdesc:gab7ea281b0cce57c44a9046f732e4112b"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br/></td></tr>
<tr class="separator:gab7ea281b0cce57c44a9046f732e4112b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="memTemplParams" colspan="2"><a class="anchor" id="gac4c1b188cdeb2280d9c803726e4d2cdc"></a>
template&lt;typename BF , int NB, bool M&gt; </td></tr>
<tr class="memitem:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___packed_channel_dynamic_reference_model.html#gac4c1b188cdeb2280d9c803726e4d2cdc">swap</a> (const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; x, const boost::gil::packed_dynamic_channel_reference&lt; BF, NB, M &gt; y)</td></tr>
<tr class="memdesc:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap for packed_dynamic_channel_reference <br/></td></tr>
<tr class="separator:gac4c1b188cdeb2280d9c803726e4d2cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Channel utilities. </p>
<dl class="section author"><dt>Author</dt><dd>Lubomir Bourdev and Hailin Jin <br/>
Adobe Systems Incorporated </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2005-2007 <br/>
Last updated on May 6, 2007</dd></dl>
<p>Definitions of standard GIL channel models </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 26 2018 16:26:16 for Generic Image Library by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>