blob: 3e9bc3d7f36115f66d946f07dc70bce72ba23ffc [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: any_image_view Class Template 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="namespaceboost.html">boost</a>::<b>gil</b>::<a class="el" href="g_i_l_0020.html">any_image_view</a>
</div>
<div class="contents">
<h1>any_image_view Class Template Reference<br>
<small>
[<a class="el" href="g_i_l_0141.html">Models</a>]</small>
</h1><!-- doxytag: class="boost::gil::any_image_view" --><!-- doxytag: inherits="variant&lt; ImageViewTypes &gt;" --><code>#include &lt;<a class="el" href="g_i_l_0003.html">any_image_view.hpp</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for any_image_view:</div>
<div class="dynsection">
<p><center><img src="g_i_l_0002.png" usemap="#any_image_view_map" border="0" alt=""></center>
<map name="any_image_view_map">
<area href="g_i_l_0062.html" alt="variant< ImageViewTypes >" shape="rect" coords="0,0,170,24">
</map>
</div>
<p>
<a href="g_i_l_0019.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename ImageViewTypes&gt;<br>
class boost::gil::any_image_view&lt; ImageViewTypes &gt;</h3>
Represents a run-time specified <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_0290.html" title="Concept for iterators, locators and views that can define a type just like the given...">HasDynamicXStepTypeConcept</a>, <a class="el" href="g_i_l_0292.html" title="Concept for locators and views that can define a type just like the given locator...">HasDynamicYStepTypeConcept</a>, Note that this class does NOT model <a class="el" href="g_i_l_0308.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>.
<p>
CLASS <a class="el" href="g_i_l_0020.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCo...">any_image_view</a><p>
Represents a view whose type (color space, <a class="el" href="g_i_l_0567.html" title="Represents a color space and ordering of channels in memory.">layout</a>, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of <code><a class="el" href="g_i_l_0040.html" title="A lightweight object that interprets memory as a 2D array of pixels. Models ImageViewConcept...">image_view</a></code>. Some of the requirements of <a class="el" href="g_i_l_0308.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>, such as the <code>value_type</code> typedef cannot be fulfilled, since the language does not allow runtime type specification. Other requirements, such as access to the pixels, would be inefficient to provide. Thus <code><a class="el" href="g_i_l_0020.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCo...">any_image_view</a></code> does not fully model <a class="el" href="g_i_l_0308.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>. However, many algorithms provide overloads taking runtime specified views and thus in many cases <code><a class="el" href="g_i_l_0020.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCo...">any_image_view</a></code> can be used in places taking a view.<p>
To perform an algorithm on <a class="el" href="g_i_l_0020.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCo...">any_image_view</a>, put the algorithm in a function object and invoke it by calling <code>apply_operation(runtime_view, algorithm_fn)</code>; <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="19cfd9d07bae93585c0a9804044565eb"></a><!-- doxytag: member="boost::gil::any_image_view::const_t" ref="19cfd9d07bae93585c0a9804044565eb" args="" -->
typedef <a class="el" href="g_i_l_0020.html">any_image_view</a><br>
&lt; typename <br>
detail::views_get_const_t<br>
&lt; ImageViewTypes &gt;::type &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5396c00a891ea52bd233a307bdaf6a64"></a><!-- doxytag: member="boost::gil::any_image_view::x_coord_t" ref="5396c00a891ea52bd233a307bdaf6a64" args="" -->
typedef std::ptrdiff_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>x_coord_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e21c9a09689df0e5118fd07840e055bb"></a><!-- doxytag: member="boost::gil::any_image_view::y_coord_t" ref="e21c9a09689df0e5118fd07840e055bb" args="" -->
typedef std::ptrdiff_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>y_coord_t</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce54a5224e10a07eb7fc9d9c78c259a0"></a><!-- doxytag: member="boost::gil::any_image_view::point_t" ref="ce54a5224e10a07eb7fc9d9c78c259a0" args="" -->
typedef <a class="el" href="g_i_l_0060.html">point2</a>&lt; std::ptrdiff_t &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>point_t</b></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="a0ab8679dd348337774da557be0aef13"></a><!-- doxytag: member="boost::gil::any_image_view::any_image_view" ref="a0ab8679dd348337774da557be0aef13" args="(const T &amp;obj)" -->
template&lt;typename T&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>any_image_view</b> (const T &amp;obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="959ea9ab653e33476208225b11cd9090"></a><!-- doxytag: member="boost::gil::any_image_view::any_image_view" ref="959ea9ab653e33476208225b11cd9090" args="(const any_image_view &amp;v)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>any_image_view</b> (const <a class="el" href="g_i_l_0020.html">any_image_view</a> &amp;v)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="43925d3fbe7a19bf4ffd8d94cb42bec9"></a><!-- doxytag: member="boost::gil::any_image_view::operator=" ref="43925d3fbe7a19bf4ffd8d94cb42bec9" args="(const T &amp;obj)" -->
template&lt;typename T&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="g_i_l_0020.html">any_image_view</a> &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (const T &amp;obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ba6a2f72ad1f25d708c4ef7d8012725"></a><!-- doxytag: member="boost::gil::any_image_view::operator=" ref="1ba6a2f72ad1f25d708c4ef7d8012725" args="(const any_image_view &amp;v)" -->
<a class="el" href="g_i_l_0020.html">any_image_view</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="g_i_l_0020.html">any_image_view</a> &amp;v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e7336b5e1b9d3674e5bb27d4adbb46a"></a><!-- doxytag: member="boost::gil::any_image_view::num_channels" ref="7e7336b5e1b9d3674e5bb27d4adbb46a" args="() const " -->
std::size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>num_channels</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d72453f8233186957b5274e32b593006"></a><!-- doxytag: member="boost::gil::any_image_view::dimensions" ref="d72453f8233186957b5274e32b593006" args="() const " -->
<a class="el" href="g_i_l_0060.html">point_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="edb657636fdfa1645708f3beaad70d8d"></a><!-- doxytag: member="boost::gil::any_image_view::width" ref="edb657636fdfa1645708f3beaad70d8d" args="() const " -->
x_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>width</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d84f7f164c70ba5b617ffa1e69f71a1"></a><!-- doxytag: member="boost::gil::any_image_view::height" ref="5d84f7f164c70ba5b617ffa1e69f71a1" args="() const " -->
y_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>height</b> () const </td></tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="g_i_l_0003.html">any_image_view.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 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>