1 <!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
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)
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)
13 Some files are held under additional license.
14 Please see "http://stlab.adobe.com/licenses.html" for more information.
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">
22 <TITLE>Generic Image Library: pixel_iterator.hpp Source File
</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"/>
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>
37 <!-- Generated by Doxygen 1.5.6 -->
38 <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>
40 <div class=
"contents">
41 <h1>pixel_iterator.hpp
</h1><a href=
"g_i_l_0243.html">Go to the documentation of this file.
</a><div class=
"fragment"><pre class=
"fragment"><a name=
"l00001"></a>00001 <span class=
"comment">/*
</span>
42 <a name=
"l00002"></a>00002 <span class=
"comment"> Copyright
2005-
2007 Adobe Systems Incorporated
</span>
43 <a name=
"l00003"></a>00003 <span class=
"comment"> </span>
44 <a name=
"l00004"></a>00004 <span class=
"comment"> Use, modification and distribution are subject to the Boost Software License,
</span>
45 <a name=
"l00005"></a>00005 <span class=
"comment"> Version
1.0. (See accompanying file LICENSE_1_0.txt or copy at
</span>
46 <a name=
"l00006"></a>00006 <span class=
"comment"> http://www.boost.org/LICENSE_1_0.txt).
</span>
47 <a name=
"l00007"></a>00007 <span class=
"comment"></span>
48 <a name=
"l00008"></a>00008 <span class=
"comment"> See http://opensource.adobe.com/gil for most recent version including documentation.
</span>
49 <a name=
"l00009"></a>00009 <span class=
"comment">*/
</span>
50 <a name=
"l00010"></a>00010
51 <a name=
"l00011"></a>00011 <span class=
"comment">/*************************************************************************************************/
</span>
52 <a name=
"l00012"></a>00012
53 <a name=
"l00013"></a>00013 <span class=
"preprocessor">#ifndef GIL_PIXEL_ITERATOR_H
</span>
54 <a name=
"l00014"></a>00014 <span class=
"preprocessor"></span><span class=
"preprocessor">#define GIL_PIXEL_ITERATOR_H
</span>
55 <a name=
"l00015"></a>00015 <span class=
"preprocessor"></span>
56 <a name=
"l00024"></a>00024
57 <a name=
"l00025"></a>00025 <span class=
"preprocessor">#include
<cassert
></span>
58 <a name=
"l00026"></a>00026 <span class=
"preprocessor">#include
<iterator
></span>
59 <a name=
"l00027"></a>00027 <span class=
"preprocessor">#include
"<a class="code
" href="g_i_l_0094.html
" title="GIL configuration file.
">gil_config.hpp</a>"</span>
60 <a name=
"l00028"></a>00028 <span class=
"preprocessor">#include
"<a class="code
" href="g_i_l_0092.html
" title="Concept check classes for GIL concepts.
">gil_concept.hpp</a>"</span>
61 <a name=
"l00029"></a>00029 <span class=
"preprocessor">#include
"<a class="code
" href="utilities_8hpp.html
" title="Various utilities not specific to the image library. Some are non-standard STL extensions...
">utilities.hpp</a>"</span>
62 <a name=
"l00030"></a>00030 <span class=
"preprocessor">#include
"<a class="code
" href="pixel_8hpp.html
" title="pixel class and related utilities
">pixel.hpp</a>"</span>
63 <a name=
"l00031"></a>00031
64 <a name=
"l00032"></a>00032 <span class=
"keyword">namespace
</span>boost {
<span class=
"keyword">namespace
</span>gil {
65 <a name=
"l00033"></a>00033
66 <a name=
"l00034"></a>00034 <span class=
"comment">//forwarded declaration (as this file is included in step_iterator.hpp)
</span>
67 <a name=
"l00035"></a>00035 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Iterator
>
68 <a name=
"l00036"></a>00036 <span class=
"keyword">class
</span>memory_based_step_iterator;
69 <a name=
"l00037"></a>00037
70 <a name=
"l00038"></a>00038 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Iterator
> <span class=
"keyword">struct
</span>dynamic_x_step_type;
71 <a name=
"l00039"></a>00039
72 <a name=
"l00042"></a>00042 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> It
>
73 <a name=
"l00043"></a><a class=
"code" href=
"g_i_l_0541.html">00043</a> <span class=
"keyword">struct
</span><a class=
"code" href=
"g_i_l_0541.html" title=
"metafunction predicate determining whether the given iterator is a plain one or an...">is_iterator_adaptor
</a> :
<span class=
"keyword">public
</span> mpl::false_{};
74 <a name=
"l00044"></a>00044
75 <a name=
"l00046"></a>00046 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> It
>
76 <a name=
"l00047"></a>00047 <span class=
"keyword">struct
</span>iterator_adaptor_get_base;
77 <a name=
"l00048"></a>00048
78 <a name=
"l00050"></a>00050 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> It,
<span class=
"keyword">typename
</span> NewBaseIt
>
79 <a name=
"l00051"></a>00051 <span class=
"keyword">struct
</span>iterator_adaptor_rebind;
80 <a name=
"l00052"></a>00052
81 <a name=
"l00054"></a>00054 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> It
>
82 <a name=
"l00055"></a>00055 <span class=
"keyword">struct
</span>const_iterator_type;
83 <a name=
"l00056"></a>00056
84 <a name=
"l00057"></a>00057 <span class=
"comment">// The default implementation when the iterator is a C pointer is to use the standard constness semantics
</span>
85 <a name=
"l00058"></a>00058 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> T
> <span class=
"keyword">struct
</span>const_iterator_type
< T*
> {
<span class=
"keyword">typedef
</span> <span class=
"keyword">const
</span> T* type; };
86 <a name=
"l00059"></a>00059 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> T
> <span class=
"keyword">struct
</span>const_iterator_type
<const T*
> {
<span class=
"keyword">typedef
</span> <span class=
"keyword">const
</span> T* type; };
87 <a name=
"l00060"></a>00060
88 <a name=
"l00063"></a>00063 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> It
>
89 <a name=
"l00064"></a><a class=
"code" href=
"g_i_l_0550.html">00064</a> <span class=
"keyword">struct
</span><a class=
"code" href=
"g_i_l_0550.html" title=
"Metafunction predicate returning whether the given iterator allows for changing its...">iterator_is_mutable
</a>{};
90 <a name=
"l00065"></a>00065
91 <a name=
"l00066"></a>00066 <span class=
"comment">// The default implementation when the iterator is a C pointer is to use the standard constness semantics
</span>
92 <a name=
"l00067"></a>00067 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> T
> <span class=
"keyword">struct
</span><a class=
"code" href=
"g_i_l_0550.html" title=
"Metafunction predicate returning whether the given iterator allows for changing its...">iterator_is_mutable
</a>< T*
> :
<span class=
"keyword">public
</span> mpl::true_{};
93 <a name=
"l00068"></a>00068 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> T
> <span class=
"keyword">struct
</span>iterator_is_mutable
<const T*
> :
<span class=
"keyword">public
</span> mpl::false_{};
94 <a name=
"l00069"></a>00069
95 <a name=
"l00074"></a>00074
96 <a name=
"l00075"></a>00075
97 <a name=
"l00076"></a>00076
98 <a name=
"l00078"></a>00078 <span class=
"comment">// HasDynamicXStepTypeConcept
</span>
99 <a name=
"l00080"></a>00080 <span class=
"comment"></span>
100 <a name=
"l00082"></a>00082 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
>
101 <a name=
"l00083"></a>00083 <span class=
"keyword">struct
</span>dynamic_x_step_type
<Pixel*
> {
102 <a name=
"l00084"></a>00084 <span class=
"keyword">typedef
</span> memory_based_step_iterator
<Pixel*
> type;
103 <a name=
"l00085"></a>00085 };
104 <a name=
"l00086"></a>00086
105 <a name=
"l00088"></a>00088 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
>
106 <a name=
"l00089"></a>00089 <span class=
"keyword">struct
</span>dynamic_x_step_type
<const Pixel*
> {
107 <a name=
"l00090"></a>00090 <span class=
"keyword">typedef
</span> memory_based_step_iterator
<const Pixel*
> type;
108 <a name=
"l00091"></a>00091 };
109 <a name=
"l00092"></a>00092
110 <a name=
"l00093"></a>00093
111 <a name=
"l00095"></a>00095 <span class=
"comment">// PixelBasedConcept
</span>
112 <a name=
"l00097"></a>00097 <span class=
"comment"></span>
113 <a name=
"l00098"></a>00098 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>color_space_type
< Pixel*
> :
<span class=
"keyword">public
</span> color_space_type
<Pixel
> {};
114 <a name=
"l00099"></a>00099 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>color_space_type
<const Pixel*
> :
<span class=
"keyword">public
</span> color_space_type
<Pixel
> {};
115 <a name=
"l00100"></a>00100
116 <a name=
"l00101"></a>00101 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>channel_mapping_type
< Pixel*
> :
<span class=
"keyword">public
</span> channel_mapping_type
<Pixel
> {};
117 <a name=
"l00102"></a>00102 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>channel_mapping_type
<const Pixel*
> :
<span class=
"keyword">public
</span> channel_mapping_type
<Pixel
> {};
118 <a name=
"l00103"></a>00103
119 <a name=
"l00104"></a>00104 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>is_planar
< Pixel*
> :
<span class=
"keyword">public
</span> is_planar
<Pixel
> {};
120 <a name=
"l00105"></a>00105 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>is_planar
<const Pixel*
> :
<span class=
"keyword">public
</span> is_planar
<Pixel
> {};
121 <a name=
"l00106"></a>00106
122 <a name=
"l00108"></a>00108 <span class=
"comment">// HomogeneousPixelBasedConcept
</span>
123 <a name=
"l00110"></a>00110 <span class=
"comment"></span>
124 <a name=
"l00111"></a>00111 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>channel_type
<Pixel*
> :
<span class=
"keyword">public
</span> channel_type
<Pixel
> {};
125 <a name=
"l00112"></a>00112 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> Pixel
> <span class=
"keyword">struct
</span>channel_type
<const Pixel*
> :
<span class=
"keyword">public
</span> channel_type
<Pixel
> {};
126 <a name=
"l00113"></a>00113
127 <a name=
"l00120"></a>00120
128 <a name=
"l00122"></a>00122 <span class=
"comment">// MemoryBasedIteratorConcept
</span>
129 <a name=
"l00124"></a>00124 <span class=
"comment"></span>
130 <a name=
"l00125"></a>00125 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> T
>
131 <a name=
"l00126"></a><a class=
"code" href=
"g_i_l_0406.html">00126</a> <span class=
"keyword">struct
</span><a class=
"code" href=
"g_i_l_0406.html">byte_to_memunit
</a> :
<span class=
"keyword">public
</span> mpl::int_
<1> {};
132 <a name=
"l00127"></a>00127
133 <a name=
"l00128"></a>00128 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> P
>
134 <a name=
"l00129"></a>00129 <span class=
"keyword">inline
</span> std::ptrdiff_t memunit_step(
<span class=
"keyword">const
</span> P*) {
<span class=
"keywordflow">return
</span> <span class=
"keyword">sizeof
</span>(P); }
135 <a name=
"l00130"></a>00130
136 <a name=
"l00131"></a>00131 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> P
>
137 <a name=
"l00132"></a>00132 <span class=
"keyword">inline
</span> std::ptrdiff_t memunit_distance(
<span class=
"keyword">const
</span> P* p1,
<span class=
"keyword">const
</span> P* p2) {
138 <a name=
"l00133"></a>00133 <span class=
"keywordflow">return
</span> (gil_reinterpret_cast_c
<const unsigned char*
>(p2)-gil_reinterpret_cast_c
<const unsigned char*
>(p1));
139 <a name=
"l00134"></a>00134 }
140 <a name=
"l00135"></a>00135
141 <a name=
"l00136"></a>00136 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> P
>
142 <a name=
"l00137"></a>00137 <span class=
"keyword">inline
</span> <span class=
"keywordtype">void
</span> memunit_advance(P*
&p, std::ptrdiff_t diff) {
143 <a name=
"l00138"></a>00138 p=(P*)((
<span class=
"keywordtype">unsigned
</span> <span class=
"keywordtype">char
</span>*)(p)+diff);
144 <a name=
"l00139"></a>00139 }
145 <a name=
"l00140"></a>00140
146 <a name=
"l00141"></a>00141 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> P
>
147 <a name=
"l00142"></a>00142 <span class=
"keyword">inline
</span> P* memunit_advanced(
<span class=
"keyword">const
</span> P* p, std::ptrdiff_t diff) {
148 <a name=
"l00143"></a>00143 <span class=
"keywordflow">return
</span> (P*)((
<span class=
"keywordtype">char
</span>*)(p)+diff);
149 <a name=
"l00144"></a>00144 }
150 <a name=
"l00145"></a>00145
151 <a name=
"l00146"></a>00146 <span class=
"comment">// memunit_advanced_ref
</span>
152 <a name=
"l00147"></a>00147 <span class=
"comment">// (shortcut to advancing a pointer by a given number of memunits and taking the reference in case the compiler is not smart enough)
</span>
153 <a name=
"l00148"></a>00148
154 <a name=
"l00149"></a>00149 <span class=
"keyword">template
</span> <<span class=
"keyword">typename
</span> P
>
155 <a name=
"l00150"></a>00150 <span class=
"keyword">inline
</span> P
& memunit_advanced_ref(P* p, std::ptrdiff_t diff) {
156 <a name=
"l00151"></a>00151 <span class=
"keywordflow">return
</span> *memunit_advanced(p,diff);
157 <a name=
"l00152"></a>00152 }
158 <a name=
"l00153"></a>00153
159 <a name=
"l00154"></a>00154 } }
<span class=
"comment">// namespace boost::gil
</span>
160 <a name=
"l00155"></a>00155
161 <a name=
"l00156"></a>00156 <span class=
"preprocessor">#endif
</span>
163 <hr size=
"1"><address style=
"text-align: right;"><small>Generated on Sat May
2 13:
50:
14 2009 for Generic Image Library by
164 <a href=
"http://www.doxygen.org/index.html">
165 <img src=
"doxygen.png" alt=
"doxygen" align=
"middle" border=
"0"></a> 1.5.6 </small></address>