blob: 59b063f292822d4b5f839407ffda31179f2d26b0 [file] [log] [blame]
<!-- 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>Generic Image Library: image.hpp File Reference</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
<LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
</head>
<body>
<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>
| <a class="qindex" href="dirs.html">Directories</a>
| <a class="qindex" href="files.html">File List</a>
| <a class="qindex" href="../index.html">GIL Home Page</a>
</div>
<!-- End Header -->
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="g_i_l_0076.html">boost</a>&nbsp;&raquo&nbsp;<a class="el" href="g_i_l_0079.html">gil</a>
</div>
<div class="contents">
<h1>image.hpp File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Templated image.
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Lubomir Bourdev and Hailin Jin <br>
Adobe Systems Incorporated </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>2005-2007 <br>
Last updated on February 12, 2007 </dd></dl>
<p>
<code>#include &lt;cstddef&gt;</code><br>
<code>#include &lt;memory&gt;</code><br>
<code>#include &quot;<a class="el" href="g_i_l_0093.html">gil_config.hpp</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="g_i_l_0224.html">image_view.hpp</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="g_i_l_0237.html">metafunctions.hpp</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="g_i_l_0001.html">algorithm.hpp</a>&quot;</code><br>
<p>
<a href="g_i_l_0223.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost.html">boost</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><b>boost::gil</b></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0038.html">image</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">container interface over <a class="el" href="g_i_l_0038.html" title="container interface over image view. Models ImageConcept, PixelBasedConcept">image</a> view. Models <a class="el" href="g_i_l_0306.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>, <a class="el" href="g_i_l_0344.html" title="Concept for all pixel-based GIL constructs, such as pixels, iterators, locators,...">PixelBasedConcept</a> <a href="g_i_l_0038.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>view, const_view</h2></td></tr>
<tr><td colspan="2">Get an image view from an image <br><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="gad0335b7d343667d626556681486f198"></a><!-- doxytag: member="image.hpp::view" ref="gad0335b7d343667d626556681486f198" args="(image&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)" -->
template&lt;typename Pixel, bool IsPlanar, typename Alloc&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const image&lt; Pixel, IsPlanar, <br>
Alloc &gt;::view_t &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="g_i_l_0135.html#gad0335b7d343667d626556681486f198">view</a> (image&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the non-constant-pixel view of an <a class="el" href="g_i_l_0038.html" title="container interface over image view. Models ImageConcept, PixelBasedConcept">image</a>. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="ged731349e60a30a3a241fd1809729996"></a><!-- doxytag: member="image.hpp::const_view" ref="ged731349e60a30a3a241fd1809729996" args="(const image&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)" -->
template&lt;typename Pixel, bool IsPlanar, typename Alloc&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const image&lt; Pixel, IsPlanar, <br>
Alloc &gt;::const_view_t&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="g_i_l_0135.html#ged731349e60a30a3a241fd1809729996">const_view</a> (const image&lt; Pixel, IsPlanar, Alloc &gt; &amp;img)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the constant-pixel view of an <a class="el" href="g_i_l_0038.html" title="container interface over image view. Models ImageConcept, PixelBasedConcept">image</a>. <br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="98182c8365ac9bef75339a8f8db79c50"></a><!-- doxytag: member="image.hpp::swap" ref="98182c8365ac9bef75339a8f8db79c50" args="(image&lt; Pixel, IsPlanar, Alloc &gt; &amp;im1, image&lt; Pixel, IsPlanar, Alloc &gt; &amp;im2)" -->
template&lt;typename Pixel, bool IsPlanar, typename Alloc&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>swap</b> (image&lt; Pixel, IsPlanar, Alloc &gt; &amp;im1, image&lt; Pixel, IsPlanar, Alloc &gt; &amp;im2)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="5dd87b373210ae277b048fe499c060a6"></a><!-- doxytag: member="image.hpp::operator==" ref="5dd87b373210ae277b048fe499c060a6" args="(const image&lt; Pixel1, IsPlanar1, Alloc1 &gt; &amp;im1, const image&lt; Pixel2, IsPlanar2, Alloc2 &gt; &amp;im2)" -->
template&lt;typename Pixel1, bool IsPlanar1, typename Alloc1, typename Pixel2, bool IsPlanar2, typename Alloc2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator==</b> (const image&lt; Pixel1, IsPlanar1, Alloc1 &gt; &amp;im1, const image&lt; Pixel2, IsPlanar2, Alloc2 &gt; &amp;im2)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="20a22693aca181354deca6800f666170"></a><!-- doxytag: member="image.hpp::operator!=" ref="20a22693aca181354deca6800f666170" args="(const image&lt; Pixel1, IsPlanar1, Alloc1 &gt; &amp;im1, const image&lt; Pixel2, IsPlanar2, Alloc2 &gt; &amp;im2)" -->
template&lt;typename Pixel1, bool IsPlanar1, typename Alloc1, typename Pixel2, bool IsPlanar2, typename Alloc2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator!=</b> (const image&lt; Pixel1, IsPlanar1, Alloc1 &gt; &amp;im1, const image&lt; Pixel2, IsPlanar2, Alloc2 &gt; &amp;im2)</td></tr>
</table>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:16 2009 for Generic Image Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>