<!-- 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: locator.hpp Source File</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> » <a class="el" href="g_i_l_0079.html">gil</a>
</div>
<div class="contents">
<h1>locator.hpp</h1><a href="locator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright 2005-2007 Adobe Systems Incorporated</span>
<a name="l00003"></a>00003 <span class="comment"> </span>
<a name="l00004"></a>00004 <span class="comment"> Use, modification and distribution are subject to the Boost Software License,</span>
<a name="l00005"></a>00005 <span class="comment"> Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at</span>
<a name="l00006"></a>00006 <span class="comment"> http://www.boost.org/LICENSE_1_0.txt).</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> See http://opensource.adobe.com/gil for most recent version including documentation.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*************************************************************************************************/</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="preprocessor">#ifndef GIL_LOCATOR_H</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define GIL_LOCATOR_H</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>
<a name="l00016"></a>00016
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include <cstddef></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <cassert></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="g_i_l_0243.html" title="pixel iterator support">pixel_iterator.hpp</a>"</span>
<a name="l00029"></a>00029
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">//forward declarations</span>
<a name="l00038"></a>00038 <span class="keyword">template</span> <<span class="keyword">typename</span> P> ptrdiff_t memunit_step(<span class="keyword">const</span> P*);
<a name="l00039"></a>00039 <span class="keyword">template</span> <<span class="keyword">typename</span> P> P* memunit_advanced(<span class="keyword">const</span> P* p, ptrdiff_t diff);
<a name="l00040"></a>00040 <span class="keyword">template</span> <<span class="keyword">typename</span> P> P& memunit_advanced_ref(P* p, ptrdiff_t diff);
<a name="l00041"></a>00041 <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator, <span class="keyword">typename</span> D> <span class="keyword">struct </span>iterator_add_deref;
<a name="l00042"></a>00042 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">class </span>point2;
<a name="l00043"></a>00043 <span class="keyword">namespace </span>detail {
<a name="l00044"></a>00044 <span class="comment">// helper class specialized for each axis of pixel_2d_locator</span>
<a name="l00045"></a>00045 <span class="keyword">template</span> <std::<span class="keywordtype">size_t</span> D, <span class="keyword">typename</span> Loc> <span class="keyword">class </span>locator_axis;
<a name="l00046"></a>00046 }
<a name="l00047"></a>00047 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>dynamic_x_step_type;
<a name="l00048"></a>00048 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>dynamic_y_step_type;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>channel_type;
<a name="l00051"></a>00051 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>color_space_type;
<a name="l00052"></a>00052 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>channel_mapping_type;
<a name="l00053"></a>00053 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>is_planar;
<a name="l00054"></a>00054 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>num_channels;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">// The type of a locator or a view that has X and Y swapped. By default it is the same</span>
<a name="l00057"></a>00057 <span class="keyword">template</span> <<span class="keyword">typename</span> T> <span class="keyword">struct </span>transposed_type {
<a name="l00058"></a>00058 <span class="keyword">typedef</span> T type;
<a name="l00059"></a>00059 };
<a name="l00060"></a>00060
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc, <span class="keyword">typename</span> XIterator, <span class="keyword">typename</span> YIterator> <span class="comment">// The concrete subclass, the X-iterator and the Y-iterator</span>
<a name="l00121"></a><a class="code" href="g_i_l_0058.html">00121</a> <span class="keyword">class </span><a class="code" href="g_i_l_0058.html" title="base class for models of PixelLocatorConceptPixel locator is similar to a pixel iterator...">pixel_2d_locator_base</a> {
<a name="l00122"></a>00122 <span class="keyword">public</span>:
<a name="l00123"></a>00123 <span class="keyword">typedef</span> XIterator x_iterator;
<a name="l00124"></a>00124 <span class="keyword">typedef</span> YIterator y_iterator;
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">// typedefs required by ConstRandomAccessNDLocatorConcept</span>
<a name="l00127"></a>00127 <span class="keyword">static</span> <span class="keyword">const</span> std::size_t num_dimensions=2;
<a name="l00128"></a>00128 <span class="keyword">typedef</span> <span class="keyword">typename</span> std::iterator_traits<x_iterator>::value_type value_type;
<a name="l00129"></a>00129 <span class="keyword">typedef</span> <span class="keyword">typename</span> std::iterator_traits<x_iterator>::reference reference; <span class="comment">// result of dereferencing</span>
<a name="l00130"></a>00130 <span class="keyword">typedef</span> <span class="keyword">typename</span> std::iterator_traits<x_iterator>::difference_type coord_t; <span class="comment">// 1D difference type (same for all dimensions)</span>
<a name="l00131"></a>00131 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">point2<coord_t></a> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>; <span class="comment">// result of operator-(locator,locator)</span>
<a name="l00132"></a>00132 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">point_t</a>;
<a name="l00133"></a>00133 <span class="keyword">template</span> <std::<span class="keywordtype">size_t</span> D> <span class="keyword">struct </span>axis {
<a name="l00134"></a>00134 <span class="keyword">typedef</span> <span class="keyword">typename</span> detail::locator_axis<D,Loc>::coord_t coord_t;
<a name="l00135"></a>00135 <span class="keyword">typedef</span> <span class="keyword">typename</span> detail::locator_axis<D,Loc>::iterator iterator;
<a name="l00136"></a>00136 };
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">// typedefs required by ConstRandomAccess2DLocatorConcept</span>
<a name="l00139"></a>00139 <span class="keyword">typedef</span> <span class="keyword">typename</span> point_t::template axis<0>::coord_t x_coord_t;
<a name="l00140"></a>00140 <span class="keyword">typedef</span> <span class="keyword">typename</span> point_t::template axis<1>::coord_t y_coord_t;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> Loc& p)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !(concrete()==p); }
<a name="l00143"></a>00143
<a name="l00144"></a>00144 x_iterator x_at(x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ Loc tmp=concrete(); tmp+=<a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">point_t</a>(dx,dy); <span class="keywordflow">return</span> tmp.x(); }
<a name="l00145"></a>00145 x_iterator x_at(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ Loc tmp=concrete(); tmp+=d; <span class="keywordflow">return</span> tmp.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>(); }
<a name="l00146"></a>00146 y_iterator y_at(x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ Loc tmp=concrete(); tmp+=<a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">point_t</a>(dx,dy); <span class="keywordflow">return</span> tmp.y(); }
<a name="l00147"></a>00147 y_iterator y_at(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ Loc tmp=concrete(); tmp+=d; <span class="keywordflow">return</span> tmp.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>(); }
<a name="l00148"></a>00148 Loc xy_at(x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ Loc tmp=concrete(); tmp+=<a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">point_t</a>(dx,dy); <span class="keywordflow">return</span> tmp; }
<a name="l00149"></a>00149 Loc xy_at(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ Loc tmp=concrete(); tmp+=d; <span class="keywordflow">return</span> tmp; }
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keyword">template</span> <std::<span class="keywordtype">size_t</span> D> <span class="keyword">typename</span> axis<D>::iterator& axis_iterator() { <span class="keywordflow">return</span> detail::locator_axis<D,Loc>()(concrete()); }
<a name="l00152"></a>00152 <span class="keyword">template</span> <std::<span class="keywordtype">size_t</span> D> <span class="keyword">typename</span> axis<D>::iterator <span class="keyword">const</span>& axis_iterator()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> detail::locator_axis<D,Loc>()(concrete()); }
<a name="l00153"></a>00153 <span class="keyword">template</span> <std::<span class="keywordtype">size_t</span> D> <span class="keyword">typename</span> axis<D>::iterator axis_iterator(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">point_t</a>& p)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> detail::locator_axis<D,Loc>()(concrete(),p); }
<a name="l00154"></a>00154
<a name="l00155"></a>00155 reference operator()(x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *x_at(dx,dy); }
<a name="l00156"></a>00156 reference operator[](<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *x_at(d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>,d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>); }
<a name="l00157"></a>00157
<a name="l00158"></a>00158 reference operator*()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *concrete().x(); }
<a name="l00159"></a>00159
<a name="l00160"></a>00160 Loc& operator+=(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d) { concrete().x()+=d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>; concrete().y()+=d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>; <span class="keywordflow">return</span> concrete(); }
<a name="l00161"></a>00161 Loc& operator-=(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d) { concrete().x()-=d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>; concrete().y()-=d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>; <span class="keywordflow">return</span> concrete(); }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 Loc operator+(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> xy_at(d); }
<a name="l00164"></a>00164 Loc operator-(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> xy_at(-d); }
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">// Some locators can cache 2D coordinates for faster subsequent access. By default there is no caching</span>
<a name="l00167"></a>00167 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a>;
<a name="l00168"></a>00168 <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a> cache_location(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d; }
<a name="l00169"></a>00169 <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a> cache_location(x_coord_t dx, y_coord_t dy)<span class="keyword">const </span>{ <span class="keywordflow">return</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>(dx,dy); }
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keyword">private</span>:
<a name="l00172"></a>00172 Loc& concrete() { <span class="keywordflow">return</span> (Loc&)*<span class="keyword">this</span>; }
<a name="l00173"></a>00173 <span class="keyword">const</span> Loc& concrete()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (<span class="keyword">const</span> Loc&)*<span class="keyword">this</span>; }
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keyword">template</span> <<span class="keyword">typename</span> X> <span class="keyword">friend</span> <span class="keyword">class </span>pixel_2d_locator;
<a name="l00176"></a>00176 };
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="comment">// helper classes for each axis of pixel_2d_locator_base</span>
<a name="l00179"></a>00179 <span class="keyword">namespace </span>detail {
<a name="l00180"></a>00180 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc>
<a name="l00181"></a>00181 <span class="keyword">class </span>locator_axis<0,Loc> {
<a name="l00182"></a>00182 <span class="keyword">typedef</span> <span class="keyword">typename</span> Loc::point_t point_t;
<a name="l00183"></a>00183 <span class="keyword">public</span>:
<a name="l00184"></a>00184 <span class="keyword">typedef</span> <span class="keyword">typename</span> point_t::template axis<0>::coord_t coord_t;
<a name="l00185"></a>00185 <span class="keyword">typedef</span> <span class="keyword">typename</span> Loc::x_iterator iterator;
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">inline</span> iterator& operator()( Loc& loc)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.x(); }
<a name="l00188"></a>00188 <span class="keyword">inline</span> iterator <span class="keyword">const</span>& operator()(<span class="keyword">const</span> Loc& loc)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.x(); }
<a name="l00189"></a>00189 <span class="keyword">inline</span> iterator operator()( Loc& loc, <span class="keyword">const</span> point_t& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.x_at(d); }
<a name="l00190"></a>00190 <span class="keyword">inline</span> iterator operator()(<span class="keyword">const</span> Loc& loc, <span class="keyword">const</span> point_t& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.x_at(d); }
<a name="l00191"></a>00191 };
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc>
<a name="l00194"></a>00194 <span class="keyword">class </span>locator_axis<1,Loc> {
<a name="l00195"></a>00195 <span class="keyword">typedef</span> <span class="keyword">typename</span> Loc::point_t point_t;
<a name="l00196"></a>00196 <span class="keyword">public</span>:
<a name="l00197"></a>00197 <span class="keyword">typedef</span> <span class="keyword">typename</span> point_t::template axis<1>::coord_t coord_t;
<a name="l00198"></a>00198 <span class="keyword">typedef</span> <span class="keyword">typename</span> Loc::y_iterator iterator;
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="keyword">inline</span> iterator& operator()( Loc& loc)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.y(); }
<a name="l00201"></a>00201 <span class="keyword">inline</span> iterator <span class="keyword">const</span>& operator()(<span class="keyword">const</span> Loc& loc)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.y(); }
<a name="l00202"></a>00202 <span class="keyword">inline</span> iterator operator()( Loc& loc, <span class="keyword">const</span> point_t& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.y_at(d); }
<a name="l00203"></a>00203 <span class="keyword">inline</span> iterator operator()(<span class="keyword">const</span> Loc& loc, <span class="keyword">const</span> point_t& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> loc.y_at(d); }
<a name="l00204"></a>00204 };
<a name="l00205"></a>00205 }
<a name="l00206"></a>00206
<a name="l00207"></a>00207 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc, <span class="keyword">typename</span> XIt, <span class="keyword">typename</span> YIt>
<a name="l00208"></a>00208 <span class="keyword">struct </span>channel_type<pixel_2d_locator_base<Loc,XIt,YIt> > : <span class="keyword">public</span> channel_type<XIt> {};
<a name="l00209"></a>00209
<a name="l00210"></a>00210 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc, <span class="keyword">typename</span> XIt, <span class="keyword">typename</span> YIt>
<a name="l00211"></a>00211 <span class="keyword">struct </span>color_space_type<pixel_2d_locator_base<Loc,XIt,YIt> > : <span class="keyword">public</span> color_space_type<XIt> {};
<a name="l00212"></a>00212
<a name="l00213"></a>00213 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc, <span class="keyword">typename</span> XIt, <span class="keyword">typename</span> YIt>
<a name="l00214"></a>00214 <span class="keyword">struct </span>channel_mapping_type<pixel_2d_locator_base<Loc,XIt,YIt> > : <span class="keyword">public</span> channel_mapping_type<XIt> {};
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="keyword">template</span> <<span class="keyword">typename</span> Loc, <span class="keyword">typename</span> XIt, <span class="keyword">typename</span> YIt>
<a name="l00217"></a>00217 <span class="keyword">struct </span>is_planar<pixel_2d_locator_base<Loc,XIt,YIt> > : <span class="keyword">public</span> is_planar<XIt> {};
<a name="l00218"></a>00218
<a name="l00239"></a>00239
<a name="l00240"></a>00240 <span class="keyword">template</span> <<span class="keyword">typename</span> StepIterator>
<a name="l00241"></a><a class="code" href="g_i_l_0044.html">00241</a> <span class="keyword">class </span><a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a> : <span class="keyword">public</span> <a class="code" href="g_i_l_0058.html" title="base class for models of PixelLocatorConceptPixel locator is similar to a pixel iterator...">pixel_2d_locator_base</a><memory_based_2d_locator<StepIterator>, typename iterator_adaptor_get_base<StepIterator>::type, StepIterator> {
<a name="l00242"></a>00242 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<StepIterator></a> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>;
<a name="l00243"></a>00243 GIL_CLASS_REQUIRE(StepIterator, boost::gil, <a class="code" href="g_i_l_0380.html" title="Step iterator concept.">StepIteratorConcept</a>)
<a name="l00244"></a>00244 <span class="keyword">public</span>:
<a name="l00245"></a>00245 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0058.html" title="base class for models of PixelLocatorConceptPixel locator is similar to a pixel iterator...">pixel_2d_locator_base<memory_based_2d_locator<StepIterator></a>, <span class="keyword">typename</span> iterator_adaptor_get_base<StepIterator>::type, StepIterator> <a class="code" href="g_i_l_0058.html" title="base class for models of PixelLocatorConceptPixel locator is similar to a pixel iterator...">parent_t</a>;
<a name="l00246"></a>00246 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<typename const_iterator_type<StepIterator>::type</a>> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">const_t</a>; <span class="comment">// same as this type, but over const values</span>
<a name="l00247"></a>00247
<a name="l00248"></a>00248 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::coord_t coord_t;
<a name="l00249"></a>00249 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::x_coord_t x_coord_t;
<a name="l00250"></a>00250 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::y_coord_t y_coord_t;
<a name="l00251"></a>00251 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::x_iterator x_iterator;
<a name="l00252"></a>00252 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::y_iterator y_iterator;
<a name="l00253"></a>00253 <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">parent_t::difference_type</a> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>;
<a name="l00254"></a>00254 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::reference reference;
<a name="l00255"></a>00255
<a name="l00256"></a>00256 <span class="keyword">template</span> <<span class="keyword">typename</span> Deref> <span class="keyword">struct </span>add_deref {
<a name="l00257"></a>00257 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<typename iterator_add_deref<StepIterator,Deref>::type</a>> type;
<a name="l00258"></a>00258 <span class="keyword">static</span> type make(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<StepIterator></a>& loc, <span class="keyword">const</span> Deref& nderef) {
<a name="l00259"></a>00259 <span class="keywordflow">return</span> type(<a class="code" href="g_i_l_0546.html" title="Returns the type (and creates an instance) of an iterator that invokes the given...">iterator_add_deref<StepIterator,Deref>::make</a>(loc.<a class="code" href="g_i_l_0044.html#8d8247ad88b73c9bb3b5d7122064ec59">y</a>(),nderef));
<a name="l00260"></a>00260 }
<a name="l00261"></a>00261 };
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>() {}
<a name="l00264"></a>00264 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>(<span class="keyword">const</span> StepIterator& yit) : _p(yit) {}
<a name="l00265"></a>00265 <span class="keyword">template</span> <<span class="keyword">typename</span> SI> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<SI></a>& loc, coord_t y_step) : _p(loc.<a class="code" href="g_i_l_0044.html#1e86d37c383d7cbafbd4969321d07ae7">x</a>(), loc.<a class="code" href="g_i_l_0044.html#663951f31f647e1b19e58b7f3443c697">row_size</a>()*y_step) {}
<a name="l00266"></a>00266 <span class="keyword">template</span> <<span class="keyword">typename</span> SI> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<SI></a>& loc, coord_t x_step, coord_t y_step, <span class="keywordtype">bool</span> transpose=<span class="keyword">false</span>)
<a name="l00267"></a>00267 : _p(make_step_iterator(loc.<a class="code" href="g_i_l_0044.html#1e86d37c383d7cbafbd4969321d07ae7">x</a>(),(transpose ? loc.<a class="code" href="g_i_l_0044.html#663951f31f647e1b19e58b7f3443c697">row_size</a>() : loc.<a class="code" href="g_i_l_0044.html#a3d224e4e4ff07d5b09c0d340c822e85">pixel_size</a>())*x_step),
<a name="l00268"></a>00268 (transpose ? loc.<a class="code" href="g_i_l_0044.html#a3d224e4e4ff07d5b09c0d340c822e85">pixel_size</a>() : loc.<a class="code" href="g_i_l_0044.html#663951f31f647e1b19e58b7f3443c697">row_size</a>())*y_step ) {}
<a name="l00269"></a>00269
<a name="l00270"></a>00270 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>(x_iterator xit, std::ptrdiff_t row_bytes) : _p(xit,row_bytes) {}
<a name="l00271"></a>00271 <span class="keyword">template</span> <<span class="keyword">typename</span> X> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator<X></a>& pl) : _p(pl.<a class="code" href="g_i_l_0044.html#63bfd1c98810e1b6194344ef389b1852">_p</a>) {}
<a name="l00272"></a>00272 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>& pl) : _p(pl.<a class="code" href="g_i_l_0044.html#63bfd1c98810e1b6194344ef389b1852">_p</a>) {}
<a name="l00273"></a>00273
<a name="l00274"></a>00274 <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>& p)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _p==p.<a class="code" href="g_i_l_0044.html#63bfd1c98810e1b6194344ef389b1852">_p</a>; }
<a name="l00275"></a>00275
<a name="l00276"></a>00276 x_iterator <span class="keyword">const</span>& x()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _p.base(); }
<a name="l00277"></a>00277 y_iterator <span class="keyword">const</span>& y()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _p; }
<a name="l00278"></a>00278 x_iterator& x() { <span class="keywordflow">return</span> _p.base(); }
<a name="l00279"></a>00279 y_iterator& y() { <span class="keywordflow">return</span> _p; }
<a name="l00280"></a>00280
<a name="l00281"></a>00281 <span class="comment">// These are faster versions of functions already provided in the superclass </span>
<a name="l00282"></a>00282 x_iterator x_at (x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_advanced(x(), offset(dx,dy)); }
<a name="l00283"></a>00283 x_iterator x_at (<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_advanced(x(), offset(d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>,d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>)); }
<a name="l00284"></a>00284 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a> xy_at (x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>(x_at( dx , dy ), row_size()); }
<a name="l00285"></a>00285 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a> xy_at (<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>(x_at( d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>, d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>), row_size()); }
<a name="l00286"></a>00286 reference operator()(x_coord_t dx, y_coord_t dy)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_advanced_ref(x(),offset(dx,dy)); }
<a name="l00287"></a>00287 reference operator[](<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_advanced_ref(x(),offset(d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>,d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>)); }
<a name="l00288"></a>00288 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>& operator+=(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d) { memunit_advance(x(),offset(d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>,d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>)); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00289"></a>00289 <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>& operator-=(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d) { memunit_advance(x(),offset(-d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>,-d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>)); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00290"></a>00290
<a name="l00291"></a>00291 <span class="comment">// Memory-based locators can have 1D caching of 2D relative coordinates</span>
<a name="l00292"></a>00292 <span class="keyword">typedef</span> std::ptrdiff_t <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a>; <span class="comment">// type used to store relative location (to allow for more efficient repeated access)</span>
<a name="l00293"></a>00293 <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a> cache_location(<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">difference_type</a>& d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> offset(d.<a class="code" href="g_i_l_0060.html#9a4f74af87a76a4c3dcb729cb0e68f8d">x</a>,d.<a class="code" href="g_i_l_0060.html#1cb2b5ea04251d543e49356ef54eb853">y</a>); }
<a name="l00294"></a>00294 <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a> cache_location(x_coord_t dx, y_coord_t dy)<span class="keyword">const </span>{ <span class="keywordflow">return</span> offset(dx,dy); }
<a name="l00295"></a>00295 reference operator[](<span class="keyword">const</span> <a class="code" href="g_i_l_0060.html" title="2D point both axes of which have the same dimension typeModels: Point2DConcept">cached_location_t</a>& loc)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_advanced_ref(x(),loc); }
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="comment">// Only make sense for memory-based locators</span>
<a name="l00298"></a>00298 std::ptrdiff_t row_size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_step(y()); } <span class="comment">// distance in mem units (bytes or bits) between adjacent rows</span>
<a name="l00299"></a>00299 std::ptrdiff_t pixel_size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_step(x()); } <span class="comment">// distance in mem units (bytes or bits) between adjacent pixels on the same row</span>
<a name="l00300"></a>00300
<a name="l00301"></a>00301 <span class="keywordtype">bool</span> is_1d_traversable(x_coord_t width)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> row_size()-pixel_size()*width==0; } <span class="comment">// is there no gap at the end of each row?</span>
<a name="l00302"></a>00302
<a name="l00303"></a>00303 <span class="comment">// Returns the vertical distance (it2.y-it1.y) between two x_iterators given the difference of their x positions</span>
<a name="l00304"></a>00304 std::ptrdiff_t y_distance_to(<span class="keyword">const</span> <a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">this_t</a>& p2, x_coord_t xDiff)<span class="keyword"> const </span>{
<a name="l00305"></a>00305 std::ptrdiff_t rowDiff=memunit_distance(x(),p2.<a class="code" href="g_i_l_0044.html#1e86d37c383d7cbafbd4969321d07ae7">x</a>())-pixel_size()*xDiff;
<a name="l00306"></a>00306 assert(( rowDiff % row_size())==0);
<a name="l00307"></a>00307 <span class="keywordflow">return</span> rowDiff / row_size();
<a name="l00308"></a>00308 }
<a name="l00309"></a>00309
<a name="l00310"></a>00310 <span class="keyword">private</span>:
<a name="l00311"></a>00311 <span class="keyword">template</span> <<span class="keyword">typename</span> X> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a>;
<a name="l00312"></a>00312 std::ptrdiff_t offset(x_coord_t x, y_coord_t y)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> y*row_size() + x*pixel_size(); }
<a name="l00313"></a>00313 StepIterator _p;
<a name="l00314"></a>00314 };
<a name="l00315"></a>00315
<a name="l00317"></a>00317 <span class="comment">// PixelBasedConcept</span>
<a name="l00319"></a>00319 <span class="comment"></span>
<a name="l00320"></a>00320 <span class="keyword">template</span> <<span class="keyword">typename</span> SI>
<a name="l00321"></a>00321 <span class="keyword">struct </span>color_space_type<<a class="code" href="g_i_l_0044.html" title="Memory-based pixel locator. Models: PixelLocatorConcept,HasDynamicXStepTypeConcept...">memory_based_2d_locator</a><SI> > : <span class="keyword">public</span> color_space_type<typename memory_based_2d_locator<SI>::parent_t> {
<a name="l00322"></a>00322 };
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="keyword">template</span> <<span class="keyword">typename</span> SI>
<a name="l00325"></a>00325 <span class="keyword">struct </span>channel_mapping_type<memory_based_2d_locator<SI> > : <span class="keyword">public</span> channel_mapping_type<typename memory_based_2d_locator<SI>::parent_t> {
<a name="l00326"></a>00326 };
<a name="l00327"></a>00327
<a name="l00328"></a>00328 <span class="keyword">template</span> <<span class="keyword">typename</span> SI>
<a name="l00329"></a>00329 <span class="keyword">struct </span>is_planar<memory_based_2d_locator<SI> > : <span class="keyword">public</span> is_planar<typename memory_based_2d_locator<SI>::parent_t> {
<a name="l00330"></a>00330 };
<a name="l00331"></a>00331
<a name="l00332"></a>00332 <span class="keyword">template</span> <<span class="keyword">typename</span> SI>
<a name="l00333"></a>00333 <span class="keyword">struct </span>channel_type<memory_based_2d_locator<SI> > : <span class="keyword">public</span> channel_type<typename memory_based_2d_locator<SI>::parent_t> {
<a name="l00334"></a>00334 };
<a name="l00335"></a>00335
<a name="l00337"></a>00337 <span class="comment">// HasDynamicXStepTypeConcept</span>
<a name="l00339"></a>00339 <span class="comment"></span>
<a name="l00340"></a>00340 <span class="comment">// Take the base iterator of SI (which is typically a step iterator) and change it to have a step in x</span>
<a name="l00341"></a>00341 <span class="keyword">template</span> <<span class="keyword">typename</span> SI>
<a name="l00342"></a>00342 <span class="keyword">struct </span>dynamic_x_step_type<memory_based_2d_locator<SI> > {
<a name="l00343"></a>00343 <span class="keyword">private</span>:
<a name="l00344"></a>00344 <span class="keyword">typedef</span> <span class="keyword">typename</span> iterator_adaptor_get_base<SI>::type base_iterator_t;
<a name="l00345"></a>00345 <span class="keyword">typedef</span> <span class="keyword">typename</span> dynamic_x_step_type<base_iterator_t>::type base_iterator_step_t;
<a name="l00346"></a>00346 <span class="keyword">typedef</span> <span class="keyword">typename</span> iterator_adaptor_rebind<SI, base_iterator_step_t>::type dynamic_step_base_t;
<a name="l00347"></a>00347 <span class="keyword">public</span>:
<a name="l00348"></a>00348 <span class="keyword">typedef</span> memory_based_2d_locator<dynamic_step_base_t> type;
<a name="l00349"></a>00349 };
<a name="l00350"></a>00350
<a name="l00352"></a>00352 <span class="comment">// HasDynamicYStepTypeConcept</span>
<a name="l00354"></a>00354 <span class="comment"></span>
<a name="l00355"></a>00355 <span class="keyword">template</span> <<span class="keyword">typename</span> SI>
<a name="l00356"></a>00356 <span class="keyword">struct </span>dynamic_y_step_type<memory_based_2d_locator<SI> > {
<a name="l00357"></a>00357 <span class="keyword">typedef</span> memory_based_2d_locator<SI> type;
<a name="l00358"></a>00358 };
<a name="l00359"></a>00359
<a name="l00360"></a>00360 } } <span class="comment">// namespace boost::gil</span>
<a name="l00361"></a>00361
<a name="l00362"></a>00362 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:14 2009 for Generic Image Library by
<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>
