Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r52726 - in trunk/libs/gil/doc/doxygen: . gil_standalone images
From: daniel_james_at_[hidden]
Date: 2009-05-02 08:38:40

Next message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r52727 - in trunk/libs/gil/doc: . doxygen/gil_standalone html"
Previous message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r52725 - trunk/libs/config/test"

Author: danieljames
Date: 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
New Revision: 52726
URL: http://svn.boost.org/trac/boost/changeset/52726

Log:
Check in the doxygen files for building standalone gil docs.

They are mostly unchanged. I've just changed some of the paths.
Added:
   trunk/libs/gil/doc/doxygen/
   trunk/libs/gil/doc/doxygen/before_after.dox (contents, props changed)
   trunk/libs/gil/doc/doxygen/design_guide.dox (contents, props changed)
   trunk/libs/gil/doc/doxygen/gil_standalone/
   trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen (contents, props changed)
   trunk/libs/gil/doc/doxygen/gil_standalone/header.html (contents, props changed)
   trunk/libs/gil/doc/doxygen/gil_standalone/main.dox (contents, props changed)
   trunk/libs/gil/doc/doxygen/images/
   trunk/libs/gil/doc/doxygen/images/interleaved.jpg (contents, props changed)
   trunk/libs/gil/doc/doxygen/images/mandel.jpg (contents, props changed)
   trunk/libs/gil/doc/doxygen/images/monkey_steps.jpg (contents, props changed)
   trunk/libs/gil/doc/doxygen/images/planar.jpg (contents, props changed)
   trunk/libs/gil/doc/doxygen/images/step_iterator.gif (contents, props changed)
   trunk/libs/gil/doc/doxygen/tutorial.dox (contents, props changed)

Added: trunk/libs/gil/doc/doxygen/before_after.dox
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/doxygen/before_after.dox 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
@@ -0,0 +1,78 @@
+/*!
+\page BeforeAfterExample Histogram Example
+
+Actual commercial code that computes the luminosity histogram (variable names have been changed and unrelated parts removed):
+
+\code
+void luminosity_hist(const uint8 *r, const uint8 *g, const uint8 *b, int rows, int cols, int sRowBytes, Histogram *hist)
+{
+ for (int r=0; r<rows; r++)
+ {
+ for (int c=0; c<cols; c++)
+ {
+ int v=RGBToGray(r[c],g[c],b[c]);
+ (*hist)[v]++;
+ }
+ r+=sRowBytes;
+ g+=sRowBytes;
+ b+=sRowBytes;
+ }
+}
+\endcode
+
+- Works only for RGB (duplicate versions exist for other color spaces)
+- Works only for 8-bit images (duplicate versions exist)
+- Works only for planar images
+
+ Histogram using GIL:
+
+
+\code
+template <typename GrayView, typename R>
+void grayimage_histogram(GrayView& img, R& hist) {
+ for (typename GrayView::iterator it=img.begin(); it!=img.end(); ++it)
+ ++hist[*it];
+}
+
+template <typename View, typename R>
+void luminosity8bit_hist(View& img, R& hist)
+{
+ grayimage_histogram(color_converted_view<gray8_pixel_t>(img),hist);
+}
+\endcode
+
+using \p boost::lambda the GIL version can be written even simpler:
+\code
+using boost::lambda;
+
+template <typename GrayView, typename R>
+void grayimage_histogram(GrayView& img, R& hist)
+{
+ for_each_pixel(img, ++var(hist)[_1]);
+}
+\endcode
+
+The GIL version:
+- Works with any supported channel depth, color space, channel ordering (RGB vs BGR), and row alignment policy.
+- Works for both planar and interleaved images.
+- Works with new color spaces, channel depths and image types that can be provided in future extensions of GIL
+- The second version is as efficient as the hand-coded version
+
+It is also very flexible. For example, to compute the histogram of the second channel of the top left quadrant of the image,
+taking every other row and column, call:
+
+\code
+grayimage_histogram(
+ nth_channel_view(
+ subsampled_view(
+ subimage_view(img, 0,0, img.width()/2,img.height()/2), // upper left quadrant
+ 2, 2 // skip every other row and column
+ ),
+ 1 // index of the second channel (for example, green for RGB)
+ ),
+ hist
+);
+\endcode
+
+Note that no extra memory is allocated and no images are copied - GIL operates on the source pixels of \p img directly.
+*/

Added: trunk/libs/gil/doc/doxygen/design_guide.dox
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/doxygen/design_guide.dox 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
@@ -0,0 +1,2848 @@
+////////////////////////////////////////////////////////////////////////////////////////
+/// \file
+/// \brief Doxygen documentation
+/// \author Lubomir Bourdev and Hailin Jin \n
+/// Adobe Systems Incorporated
+///
+///
+////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+\page GILDesignGuide Generic Image Library Design Guide
+
+\author Lubomir Bourdev (lbourdev_at_[hidden]) and Hailin Jin (hljin_at_[hidden]) \n
+ Adobe Systems Incorporated
+\version 2.1
+\date September 15, 2007
+
+
+This document describes the design of the Generic Image Library, a C++ image-processing library that abstracts image representation from algorithms on images.
+It covers more than you need to know for a causal use of GIL. You can find a quick, jump-start GIL tutorial on the main GIL page at http://stlab.adobe.com/gil
+
+- \ref OverviewSectionDG
+- \ref ConceptsSectionDG
+- \ref PointSectionDG
+- \ref ChannelSectionDG
+- \ref ColorSpaceSectionDG
+- \ref ColorBaseSectionDG
+- \ref PixelSectionDG
+- \ref PixelIteratorSectionDG
+ - \ref FundamentalIteratorDG
+ - \ref IteratorAdaptorDG
+ - \ref PixelDereferenceAdaptorAG
+ - \ref StepIteratorDG
+ - \ref LocatorDG
+ - \ref IteratorFrom2DDG
+- \ref ImageViewSectionDG
+ - \ref ImageViewFrowRawDG
+ - \ref ImageViewFrowImageViewDG
+- \ref ImageSectionDG
+- \ref VariantSecDG
+- \ref MetafunctionsDG
+- \ref IO_DG
+- \ref SampleImgCodeDG
+ - \ref PixelLevelExampleDG
+ - \ref SafeAreaExampleDG
+ - \ref HistogramExampleDG
+ - \ref ImageViewsExampleDG
+- \ref ExtendingGIL_DG
+ - \ref NewColorSpacesDG
+ - \ref NewColorConversionDG
+ - \ref NewChannelsDG
+ - \ref NewImagesDG
+- \ref TechnicalitiesDG
+- \ref ConclusionDG
+
+ 
+<hr>
+\section OverviewSectionDG 1. Overview
+
+Images are essential in any image processing, vision and video project, and yet the variability in image representations makes it difficult
+to write imaging algorithms that are both generic and efficient. In this section we will describe some of the challenges that we would like to address.
+
+In the following discussion an image is a 2D array of pixels. A pixel is a set of color channels that represents the color at a given point in an image. Each
+channel represents the value of a color component.
+There are two common memory structures for an image. Interleaved images are represented by grouping the pixels together in memory and
+interleaving all channels together, whereas planar images keep the channels in separate color planes. Here is a 4x3 RGB image in
+which the second pixel of the first row is marked in red, in interleaved form:
+
+\image html interleaved.jpg
+and in planar form:
+
+\image html planar.jpg
+
+Note also that rows may optionally be aligned resulting in a potential padding at the end of rows.
+
+The Generic Image Library (GIL) provides models for images that vary in:
+- Structure (planar vs. interleaved)
+- Color space and presence of alpha (RGB, RGBA, CMYK, etc.)
+- Channel depth (8-bit, 16-bit, etc.)
+- Order of channels (RGB vs. BGR, etc.)
+- Row alignment policy (no alignment, word-alignment, etc.)
+
+It also supports user-defined models of images, and images whose parameters are specified at run-time.
+GIL abstracts image representation from algorithms applied on images and allows us to write the algorithm once and have it work
+on any of the above image variations while generating code that is comparable in speed to that of hand-writing the algorithm for a specific image type.
+
+This document follows bottom-up design. Each section defines concepts that build on top of concepts defined in previous sections.
+It is recommended to read the sections in order.
+
+<hr>
+\section ConceptsSectionDG 2. About Concepts
+
+All constructs in GIL are models of GIL concepts. A \em concept is a set of requirements that a type (or a set of related types) must fulfill to
+be used correctly in generic algorithms. The requirements include syntactic and algorithming guarantees.
+For example, GIL's class \p pixel is a model of GIL's \p PixelConcept. The user may substitute the pixel class with one of their own, and, as long as
+it satisfies the requirements of \p PixelConcept, all other GIL classes and algorithms can be used with it. See more about concepts here:
+http://www.generic-programming.org/languages/conceptcpp/
+
+In this document we will use a syntax for defining concepts that is described in a proposal for a Concepts extension to C++0x specified here:
+http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2081.pdf
+
+Here are some common concepts that will be used in GIL. Most of them are defined here:
+http://www.generic-programming.org/languages/conceptcpp/concept_web.php
+
+\code
+auto concept DefaultConstructible<typename T> {
+ T::T();
+};
+
+auto concept CopyConstructible<typename T> {
+ T::T(T);
+ T::~T();
+};
+
+auto concept Assignable<typename T, typename U = T> {
+ typename result_type;
+ result_type operator=(T&, U);
+};
+
+auto concept EqualityComparable<typename T, typename U = T> {
+ bool operator==(T x, T y);
+ bool operator!=(T x, T y) { return !(x==y); }
+};
+
+concept SameType<typename T, typename U> { /* unspecified */ };
+template<typename T> concept_map SameType<T, T> { /* unspecified */ };
+
+auto concept Swappable<typename T> {
+ void swap(T& t, T& u);
+};
+\endcode
+
+Here are some additional basic concepts that GIL needs:
+
+\code
+
+auto concept Regular<typename T> : DefaultConstructible<T>, CopyConstructible<T>, EqualityComparable<T>, Assignable<T>, Swappable<T> {};
+
+auto concept Metafunction<typename T> {
+ typename type;
+};
+
+\endcode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+\section PointSectionDG 3. Point
+
+A point defines the location of a pixel inside an image. It can also be used to describe the dimensions of an image.
+In most general terms, points are N-dimensional and model the following concept:
+
+\code
+concept PointNDConcept<typename T> : Regular<T> {
+ // the type of a coordinate along each axis
+ template <size_t K> struct axis; where Metafunction<axis>;
+
+ const size_t num_dimensions;
+
+ // accessor/modifier of the value of each axis.
+ template <size_t K> const typename axis<K>::type& T::axis_value() const;
+ template <size_t K> typename axis<K>::type& T::axis_value();
+};
+\endcode
+
+GIL uses a two-dimensional point, which is a refinement of \p PointNDConcept in which both dimensions are of the same type:
+
+\code
+concept Point2DConcept<typename T> : PointNDConcept<T> {
+ where num_dimensions == 2;
+ where SameType<axis<0>::type, axis<1>::type>;
+
+ typename value_type = axis<0>::type;
+
+ const value_type& operator[](const T&, size_t i);
+ value_type& operator[]( T&, size_t i);
+
+ value_type x,y;
+};
+\endcode
+
+Related Concepts:
+
+- PointNDConcept\<T>
+- Point2DConcept\<T>
+
+Models:
+
+GIL provides a model of \p Point2DConcept, \p point2<T> where \p T is the coordinate type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section ChannelSectionDG 4. Channel
+
+A channel indicates the intensity of a color component (for example, the red channel in an RGB pixel).
+Typical channel operations are getting, comparing and setting the channel values. Channels have associated
+minimum and maximum value. GIL channels model the following concept:
+
+\code
+
+concept ChannelConcept<typename T> : EqualityComparable<T> {
+ typename value_type = T; // use channel_traits<T>::value_type to access it
+ where ChannelValueConcept<value_type>;
+ typename reference = T&; // use channel_traits<T>::reference to access it
+ typename pointer = T*; // use channel_traits<T>::pointer to access it
+ typename const_reference = const T&; // use channel_traits<T>::const_reference to access it
+ typename const_pointer = const T*; // use channel_traits<T>::const_pointer to access it
+ static const bool is_mutable; // use channel_traits<T>::is_mutable to access it
+
+ static T min_value(); // use channel_traits<T>::min_value to access it
+ static T max_value(); // use channel_traits<T>::min_value to access it
+};
+
+concept MutableChannelConcept<ChannelConcept T> : Swappable<T>, Assignable<T> {};
+
+concept ChannelValueConcept<ChannelConcept T> : Regular<T> {};
+\endcode
+
+GIL allows built-in integral and floating point types to be channels. Therefore the associated types and range information
+are defined in \p channel_traits with the following default implementation:
+
+\code
+template <typename T>
+struct channel_traits {
+ typedef T value_type;
+ typedef T& reference;
+ typedef T* pointer;
+ typedef T& const const_reference;
+ typedef T* const const_pointer;
+
+ static value_type min_value() { return std::numeric_limits<T>::min(); }
+ static value_type max_value() { return std::numeric_limits<T>::max(); }
+};
+\endcode
+
+Two channel types are compatible if they have the same value type:
+
+\code
+concept ChannelsCompatibleConcept<ChannelConcept T1, ChannelConcept T2> {
+ where SameType<T1::value_type, T2::value_type>;
+};
+\endcode
+
+A channel may be convertible to another channel:
+
+\code
+template <ChannelConcept Src, ChannelValueConcept Dst>
+concept ChannelConvertibleConcept {
+ Dst channel_convert(Src);
+};
+\endcode
+
+Note that \p ChannelConcept and \p MutableChannelConcept do not require a default constructor. Channels that also
+support default construction (and thus are regular types) model \p ChannelValueConcept. To understand the motivation
+for this distinction, consider a 16-bit RGB pixel in a "565" bit pattern. Its channels correspond to bit ranges. To support
+such channels, we need to create a custom proxy class corresponding to a reference to a subbyte channel.
+Such a proxy reference class models only \p ChannelConcept, because, similar to native C++ references, it
+may not have a default constructor.
+
+Note also that algorithms may impose additional requirements on channels, such as support for arithmentic operations.
+
+Related Concepts:
+
+- ChannelConcept\<T>
+- ChannelValueConcept\<T>
+- MutableChannelConcept\<T>
+- ChannelsCompatibleConcept\<T1,T2>
+- ChannelConvertibleConcept\<SrcChannel,DstChannel>
+
+Models:
+
+All built-in integral and floating point types are valid channels. GIL provides standard typedefs for some integral channels:
+
+\code
+typedef boost::uint8_t bits8;
+typedef boost::uint16_t bits16;
+typedef boost::uint32_t bits32;
+typedef boost::int8_t bits8s;
+typedef boost::int16_t bits16s;
+typedef boost::int32_t bits32s;
+\endcode
+
+The minimum and maximum values of a channel modeled by a built-in type correspond to the minimum and maximum physical range of the built-in type,
+as specified by its \p std::numeric_limits. Sometimes the physical range is not appropriate. GIL provides \p scoped_channel_value, a model for a
+channel adapter that allows for specifying a custom range. We use it to define a [0..1] floating point channel type as follows:
+
+\code
+struct float_zero { static float apply() { return 0.0f; } };
+struct float_one { static float apply() { return 1.0f; } };
+typedef scoped_channel_value<float,float_zero,float_one> bits32f;
+\endcode
+
+GIL also provides models for channels corresponding to ranges of bits:
+
+\code
+// Value of a channel defined over NumBits bits. Models ChannelValueConcept
+template <int NumBits> class packed_channel_value;
+
+// Reference to a channel defined over NumBits bits. Models ChannelConcept
+template <int FirstBit,
+ int NumBits, // Defines the sequence of bits in the data value that contain the channel
+ bool Mutable> // true if the reference is mutable
+class packed_channel_reference;
+
+// Reference to a channel defined over NumBits bits. Its FirstBit is a run-time parameter. Models ChannelConcept
+template <int NumBits, // Defines the sequence of bits in the data value that contain the channel
+ bool Mutable> // true if the reference is mutable
+class packed_dynamic_channel_reference;
+\endcode
+
+Note that there are two models of a reference proxy which differ based on whether the offset of the channel range is
+specified as a template or a run-time parameter. The first model is faster and more compact while the second model is more
+flexible. For example, the second model allows us to construct an iterator over bitrange channels.
+
+Algorithms:
+
+Here is how to construct the three channels of a 16-bit "565" pixel and set them to their maximum value:
+
+\code
+typedef packed_channel_reference<0,5,true> channel16_0_5_reference_t;
+typedef packed_channel_reference<5,6,true> channel16_5_6_reference_t;
+typedef packed_channel_reference<11,5,true> channel16_11_5_reference_t;
+
+boost::uint16_t data=0;
+channel16_0_5_reference_t channel1(&data);
+channel16_5_6_reference_t channel2(&data);
+channel16_11_5_reference_t channel3(&data);
+
+channel1=channel_traits<channel16_0_5_reference_t>::max_value();
+channel2=channel_traits<channel16_5_6_reference_t>::max_value();
+channel3=channel_traits<channel16_11_5_reference_t>::max_value();
+assert(data==65535);
+\endcode
+
+Assignment, equality comparison and copy construction are defined only between compatible channels:
+
+\code
+packed_channel_value<5> channel_6bit = channel1;
+channel_6bit = channel3;
+
+//channel_6bit = channel2; // compile error: Assignment between incompatible channels.
+\endcode
+
+All channel models provided by GIL are pairwise convertible:
+
+\code
+channel1 = channel_traits<channel16_0_5_reference_t>::max_value();
+assert(channel1 == 31);
+
+bits16 chan16 = channel_convert<bits16>(channel1);
+assert(chan16 == 65535);
+\endcode
+
+Channel conversion is a lossy operation. GIL's channel conversion is a linear transformation between the ranges of the source and destination channel.
+It maps precisely the minimum to the minimum and the maximum to the maximum. (For example, to convert from uint8_t to uint16_t GIL does not do a bit shift
+because it will not properly match the maximum values. Instead GIL multiplies the source by 257).
+
+All channel models that GIL provides are convertible from/to an integral or floating point type. Thus they support arithmetic operations.
+Here are the channel-level algorithms that GIL provides:
+
+\code
+// Converts a source channel value into a destrination channel. Linearly maps the value of the source
+// into the range of the destination
+template <typename DstChannel, typename SrcChannel>
+typename channel_traits<DstChannel>::value_type channel_convert(SrcChannel src);
+
+// returns max_value - x + min_value
+template <typename Channel>
+typename channel_traits<Channel>::value_type channel_invert(Channel x);
+
+// returns a * b / max_value
+template <typename Channel>
+typename channel_traits<Channel>::value_type channel_multiply(Channel a, Channel b);
+\endcode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section ColorSpaceSectionDG 5. Color Space and Layout
+
+A color space captures the set and interpretation of channels comprising a pixel. It is an MPL random access sequence containing the types
+of all elements in the color space. Two color spaces are considered compatible if they are equal (i.e. have the same set of colors in the same order).
+
+Related Concepts:
+
+- ColorSpaceConcept\<ColorSpace>
+- ColorSpacesCompatibleConcept\<ColorSpace1,ColorSpace2>
+- ChannelMappingConcept\<Mapping>
+
+Models:
+
+GIL currently provides the following color spaces: \p gray_t, \p rgb_t, \p rgba_t, and \p cmyk_t. It also provides unnamed
+N-channel color spaces of two to five channels, \p devicen_t<2>,
+\p devicen_t<3>, \p devicen_t<4>, \p devicen_t<5>. Besides the standard layouts, it provides \p bgr_layout_t, \p bgra_layout_t, \p abgr_layout_t
+and \p argb_layout_t.
+
+As an example, here is how GIL defines the RGBA color space:
+
+\code
+struct red_t{};
+struct green_t{};
+struct blue_t{};
+struct alpha_t{};
+typedef mpl::vector4<red_t,green_t,blue_t,alpha_t> rgba_t;
+\endcode
+
+The ordering of the channels in the color space definition specifies their semantic order. For example, \p red_t is the first semantic channel of \p rgba_t.
+While there is a unique semantic ordering of the channels in a color space, channels may vary in their physical ordering in memory. The mapping of channels is
+specified by \p ChannelMappingConcept, which is an MPL random access sequence of integral types. A color space and its associated mapping are often used together.
+Thus they are grouped in GIL's layout:
+
+\code
+template <typename ColorSpace,
+ typename ChannelMapping = mpl::range_c<int,0,mpl::size<ColorSpace>::value> >
+struct layout {
+ typedef ColorSpace color_space_t;
+ typedef ChannelMapping channel_mapping_t;
+};
+\endcode
+
+Here is how to create layouts for the RGBA color space:
+
+\code
+typedef layout<rgba_t> rgba_layout_t; // default ordering is 0,1,2,3...
+typedef layout<rgba_t, mpl::vector4_c<int,2,1,0,3> > bgra_layout_t;
+typedef layout<rgba_t, mpl::vector4_c<int,1,2,3,0> > argb_layout_t;
+typedef layout<rgba_t, mpl::vector4_c<int,3,2,1,0> > abgr_layout_t;
+\endcode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section ColorBaseSectionDG 6. Color Base
+
+A color base is a container of color elements. The most common use of color base is in the implementation of a pixel, in which case the color
+elements are channel values. The color base concept, however, can be used in other scenarios. For example, a planar pixel has channels that are not
+contiguous in memory. Its reference is a proxy class that uses a color base whose elements are channel references. Its iterator uses a color base
+whose elements are channel iterators.
+
+Color base models must satisfy the following concepts:
+
+\code
+concept ColorBaseConcept<typename T> : CopyConstructible<T>, EqualityComparable<T> {
+ // a GIL layout (the color space and element permutation)
+ typename layout_t;
+
+ // The type of K-th element
+ template <int K> struct kth_element_type;
+ where Metafunction<kth_element_type>;
+
+ // The result of at_c
+ template <int K> struct kth_element_const_reference_type;
+ where Metafunction<kth_element_const_reference_type>;
+
+ template <int K> kth_element_const_reference_type<T,K>::type at_c(T);
+
+ template <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }
+ T::T(T2);
+ template <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }
+ bool operator==(const T&, const T2&);
+ template <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }
+ bool operator!=(const T&, const T2&);
+
+};
+
+concept MutableColorBaseConcept<ColorBaseConcept T> : Assignable<T>, Swappable<T> {
+ template <int K> struct kth_element_reference_type;
+ where Metafunction<kth_element_reference_type>;
+
+ template <int K> kth_element_reference_type<T,K>::type at_c(T);
+
+ template <ColorBaseConcept T2> where { ColorBasesCompatibleConcept<T,T2> }
+ T& operator=(T&, const T2&);
+};
+
+concept ColorBaseValueConcept<typename T> : MutableColorBaseConcept<T>, Regular<T> {
+};
+
+concept HomogeneousColorBaseConcept<ColorBaseConcept CB> {
+ // For all K in [0 ... size<C1>::value-1):
+ // where SameType<kth_element_type<K>::type, kth_element_type<K+1>::type>;
+ kth_element_const_reference_type<0>::type dynamic_at_c(const CB&, std::size_t n) const;
+};
+
+concept MutableHomogeneousColorBaseConcept<MutableColorBaseConcept CB> : HomogeneousColorBaseConcept<CB> {
+ kth_element_reference_type<0>::type dynamic_at_c(const CB&, std::size_t n);
+};
+
+concept HomogeneousColorBaseValueConcept<typename T> : MutableHomogeneousColorBaseConcept<T>, Regular<T> {
+};
+
+concept ColorBasesCompatibleConcept<ColorBaseConcept C1, ColorBaseConcept C2> {
+ where SameType<C1::layout_t::color_space_t, C2::layout_t::color_space_t>;
+ // also, for all K in [0 ... size<C1>::value):
+ // where Convertible<kth_semantic_element_type<C1,K>::type, kth_semantic_element_type<C2,K>::type>;
+ // where Convertible<kth_semantic_element_type<C2,K>::type, kth_semantic_element_type<C1,K>::type>;
+};
+\endcode
+
+A color base must have an associated layout (which consists of a color space, as well as an ordering of the channels).
+There are two ways to index the elements of a color base: A physical index corresponds to the way they are ordered in memory, and
+a semantic index corresponds to the way the elements are ordered in their color space.
+For example, in the RGB color space the elements are ordered as {red_t, green_t, blue_t}. For a color base with a BGR layout, the first element
+in physical ordering is the blue element, whereas the first semantic element is the red one.
+Models of \p ColorBaseConcept are required to provide the \p at_c<K>(ColorBase) function, which allows for accessing the elements based on their
+physical order. GIL provides a \p semantic_at_c<K>(ColorBase) function (described later) which can operate on any model of ColorBaseConcept and returns
+the corresponding semantic element.
+
+Two color bases are compatible if they have the same color space and their elements (paired semantically) are convertible to each other.
+
+
+Models:
+
+GIL provides a model for a homogeneous color base (a color base whose elements all have the same type).
+
+\code
+namespace detail {
+ template <typename Element, typename Layout, int K> struct homogeneous_color_base;
+}
+\endcode
+
+It is used in the implementation of GIL's pixel, planar pixel reference and planar pixel iterator.
+Another model of \p ColorBaseConcept is \p packed_pixel - it is a pixel whose channels are bit ranges. See the \ref PixelSectionDG
+section for more.
+
+Algorithms:
+
+GIL provides the following functions and metafunctions operating on color bases:
+
+\code
+// Metafunction returning an mpl::int_ equal to the number of elements in the color base
+template <class ColorBase> struct size;
+
+// Returns the type of the return value of semantic_at_c<K>(color_base)
+template <class ColorBase, int K> struct kth_semantic_element_reference_type;
+template <class ColorBase, int K> struct kth_semantic_element_const_reference_type;
+
+// Returns a reference to the element with K-th semantic index.
+template <class ColorBase, int K>
+typename kth_semantic_element_reference_type<ColorBase,K>::type semantic_at_c(ColorBase& p)
+template <class ColorBase, int K>
+typename kth_semantic_element_const_reference_type<ColorBase,K>::type semantic_at_c(const ColorBase& p)
+
+// Returns the type of the return value of get_color<Color>(color_base)
+template <typename Color, typename ColorBase> struct color_reference_t;
+template <typename Color, typename ColorBase> struct color_const_reference_t;
+
+// Returns a reference to the element corresponding to the given color
+template <typename ColorBase, typename Color>
+typename color_reference_t<Color,ColorBase>::type get_color(ColorBase& cb, Color=Color());
+template <typename ColorBase, typename Color>
+typename color_const_reference_t<Color,ColorBase>::type get_color(const ColorBase& cb, Color=Color());
+
+// Returns the element type of the color base. Defined for homogeneous color bases only
+template <typename ColorBase> struct element_type;
+template <typename ColorBase> struct element_reference_type;
+template <typename ColorBase> struct element_const_reference_type;
+\endcode
+
+GIL also provides the following algorithms which operate on color bases. Note that they all pair the elements semantically:
+
+\code
+// Equivalents to std::equal, std::copy, std::fill, std::generate
+template <typename CB1,typename CB2> bool static_equal(const CB1& p1, const CB2& p2);
+template <typename Src,typename Dst> void static_copy(const Src& src, Dst& dst);
+template <typename CB, typename Op> void static_generate(CB& dst,Op op);
+
+// Equivalents to std::transform
+template <typename CB , typename Dst,typename Op> Op static_transform( CB&,Dst&,Op);
+template <typename CB , typename Dst,typename Op> Op static_transform(const CB&,Dst&,Op);
+template <typename CB1,typename CB2,typename Dst,typename Op> Op static_transform( CB1&, CB2&,Dst&,Op);
+template <typename CB1,typename CB2,typename Dst,typename Op> Op static_transform(const CB1&, CB2&,Dst&,Op);
+template <typename CB1,typename CB2,typename Dst,typename Op> Op static_transform( CB1&,const CB2&,Dst&,Op);
+template <typename CB1,typename CB2,typename Dst,typename Op> Op static_transform(const CB1&,const CB2&,Dst&,Op);
+
+// Equivalents to std::for_each
+template <typename CB1, typename Op> Op static_for_each( CB1&,Op);
+template <typename CB1, typename Op> Op static_for_each(const CB1&,Op);
+template <typename CB1,typename CB2, typename Op> Op static_for_each( CB1&, CB2&,Op);
+template <typename CB1,typename CB2, typename Op> Op static_for_each( CB1&,const CB2&,Op);
+template <typename CB1,typename CB2, typename Op> Op static_for_each(const CB1&, CB2&,Op);
+template <typename CB1,typename CB2, typename Op> Op static_for_each(const CB1&,const CB2&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each( CB1&, CB2&, CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each( CB1&, CB2&,const CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each( CB1&,const CB2&, CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each( CB1&,const CB2&,const CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each(const CB1&, CB2&, CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each(const CB1&, CB2&,const CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each(const CB1&,const CB2&, CB3&,Op);
+template <typename CB1,typename CB2,typename CB3,typename Op> Op static_for_each(const CB1&,const CB2&,const CB3&,Op);
+
+// The following algorithms are only defined for homogeneous color bases:
+// Equivalent to std::fill
+template <typename HCB, typename Element> void static_fill(HCB& p, const Element& v);
+
+// Equivalents to std::min_element and std::max_element
+template <typename HCB> typename element_const_reference_type<HCB>::type static_min(const HCB&);
+template <typename HCB> typename element_reference_type<HCB>::type static_min( HCB&);
+template <typename HCB> typename element_const_reference_type<HCB>::type static_max(const HCB&);
+template <typename HCB> typename element_reference_type<HCB>::type static_max( HCB&);
+\endcode
+
+These algorithms are designed after the corresponding STL algorithms, except that instead of ranges they take color bases and operate on their elements.
+In addition, they are implemented with a compile-time recursion (thus the prefix "static_"). Finally, they pair the elements semantically instead of based
+on their physical order in memory. For example, here is the implementation of \p static_equal:
+
+\code
+namespace detail {
+template <int K> struct element_recursion {
+ template <typename P1,typename P2>
+ static bool static_equal(const P1& p1, const P2& p2) {
+ return element_recursion<K-1>::static_equal(p1,p2) &&
+ semantic_at_c<K-1>(p1)==semantic_at_c<N-1>(p2);
+ }
+};
+template <> struct element_recursion<0> {
+ template <typename P1,typename P2>
+ static bool static_equal(const P1&, const P2&) { return true; }
+};
+}
+
+template <typename P1,typename P2>
+bool static_equal(const P1& p1, const P2& p2) {
+ gil_function_requires<ColorSpacesCompatibleConcept<P1::layout_t::color_space_t,P2::layout_t::color_space_t> >();
+ return detail::element_recursion<size<P1>::value>::static_equal(p1,p2);
+}
+\endcode
+
+This algorithm is used when invoking \p operator== on two pixels, for example. By using semantic accessors we are properly comparing an RGB pixel
+to a BGR pixel. Notice also that all of the above algorithms taking more than one color base require that they all have the same color space.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section PixelSectionDG 7. Pixel
+
+A pixel is a set of channels defining the color at a given point in an image. Conceptually, a pixel is little more than a color base whose elements
+model \p ChannelConcept.
+All properties of pixels inherit from color bases: pixels may be homogeneous if all of their channels have the same type; otherwise they are
+called heterogeneous. The channels of a pixel may be addressed using semantic or physical indexing, or by color; all color-base algorithms
+work on pixels as well. Two pixels are compatible if their color spaces are the same and their channels, paired semantically, are compatible.
+Note that constness, memory organization and reference/value are ignored. For example, an 8-bit RGB planar reference is compatible to a constant 8-bit
+BGR interleaved pixel value. Most pairwise pixel operations (copy construction, assignment, equality, etc.) are only defined for compatible pixels.
+
+Pixels (as well as other GIL constructs built on pixels, such as iterators, locators, views and images) must provide metafunctions to access
+their color space, channel mapping, number of channels, and (for homogeneous pixels) the channel type:
+
+\code
+concept PixelBasedConcept<typename T> {
+ typename color_space_type<T>;
+ where Metafunction<color_space_type<T> >;
+ where ColorSpaceConcept<color_space_type<T>::type>;
+ typename channel_mapping_type<T>;
+ where Metafunction<channel_mapping_type<T> >;
+ where ChannelMappingConcept<channel_mapping_type<T>::type>;
+ typename is_planar<T>;
+ where Metafunction<is_planar<T> >;
+ where SameType<is_planar<T>::type, bool>;
+};
+
+concept HomogeneousPixelBasedConcept<PixelBasedConcept T> {
+ typename channel_type<T>;
+ where Metafunction<channel_type<T> >;
+ where ChannelConcept<channel_type<T>::type>;
+};
+\endcode
+
+Pixels model the following concepts:
+
+\code
+concept PixelConcept<typename P> : ColorBaseConcept, PixelBasedConcept {
+ where is_pixel::type::value==true;
+ // where for each K [0..size::value-1]:
+ // ChannelConcept<kth_element_type<K> >;
+
+ typename value_type; where PixelValueConcept<value_type>;
+ typename reference; where PixelConcept<reference>;
+ typename const_reference; where PixelConcept<const_reference>;
+ static const bool P::is_mutable;
+
+ template <PixelConcept P2> where { PixelConcept<P,P2> }
+ P::P(P2);
+ template <PixelConcept P2> where { PixelConcept<P,P2> }
+ bool operator==(const P&, const P2&);
+ template <PixelConcept P2> where { PixelConcept<P,P2> }
+ bool operator!=(const P&, const P2&);
+};
+
+concept MutablePixelConcept<typename P> : PixelConcept, MutableColorBaseConcept {
+ where is_mutable==true;
+};
+
+concept HomogeneousPixelConcept<PixelConcept P> : HomogeneousColorBaseConcept, HomogeneousPixelBasedConcept {
+ P::template element_const_reference_type::type operator[](P p, std::size_t i) const { return dynamic_at_c(P,i); }
+};
+
+concept MutableHomogeneousPixelConcept<MutablePixelConcept P> : MutableHomogeneousColorBaseConcept {
+ P::template element_reference_type::type operator[](P p, std::size_t i) { return dynamic_at_c(p,i); }
+};
+
+concept PixelValueConcept<typename P> : PixelConcept, Regular {
+ where SameType<value_type,P>;
+};
+
+concept PixelsCompatibleConcept<PixelConcept P1, PixelConcept P2> : ColorBasesCompatibleConcept<P1,P2> {
+ // where for each K [0..size<P1>::value):
+ // ChannelsCompatibleConcept<kth_semantic_element_type<P1,K>::type, kth_semantic_element_type<P2,K>::type>;
+};
+\endcode
+
+A pixel is convertible to a second pixel if it is possible to approximate its color in the form of the second pixel. Conversion is an explicit,
+non-symmetric and often lossy operation (due to both channel and color space approximation). Convertability requires modeling the following concept:
+
+\code
+template <PixelConcept SrcPixel, MutablePixelConcept DstPixel>
+concept PixelConvertibleConcept {
+ void color_convert(const SrcPixel&, DstPixel&);
+};
+\endcode
+
+The distinction between \p PixelConcept and \p PixelValueConcept is analogous to that for channels and color bases - pixel reference proxies model both,
+but only pixel values model the latter.
+
+Related Concepts:
+
+- PixelBasedConcept\
+- PixelConcept\<Pixel>
+- MutablePixelConcept\<Pixel>
+- PixelValueConcept\<Pixel>
+- HomogeneousPixelConcept\<Pixel>
+- MutableHomogeneousPixelConcept\<Pixel>
+- HomogeneousPixelValueConcept\<Pixel>
+- PixelsCompatibleConcept\<Pixel1,Pixel2>
+- PixelConvertibleConcept\<SrcPixel,DstPixel>
+
+Models:
+
+The most commonly used pixel is a homogeneous pixel whose values are together in memory.
+For this purpose GIL provides the struct \p pixel, templated over the channel value and layout:
+
+\code
+// models HomogeneousPixelValueConcept
+template <typename ChannelValue, typename Layout> struct pixel;
+
+// Those typedefs are already provided by GIL
+typedef pixel<bits8, rgb_layout_t> rgb8_pixel_t;
+typedef pixel<bits8, bgr_layout_t> bgr8_pixel_t;
+
+bgr8_pixel_t bgr8(255,0,0); // pixels can be initialized with the channels directly
+rgb8_pixel_t rgb8(bgr8); // compatible pixels can also be copy-constructed
+
+rgb8 = bgr8; // assignment and equality is defined between compatible pixels
+assert(rgb8 == bgr8); // assignment and equality operate on the semantic channels
+
+// The first physical channels of the two pixels are different
+assert(at_c<0>(rgb8) != at_c<0>(bgr8));
+assert(dynamic_at_c(bgr8,0) != dynamic_at_c(rgb8,0));
+assert(rgb8[0] != bgr8[0]); // same as above (but operator[] is defined for pixels only)
+\endcode
+
+Planar pixels have their channels distributed in memory. While they share the same value type (\p pixel) with interleaved pixels, their
+reference type is a proxy class containing references to each of the channels. This is implemented with the struct \p planar_pixel_reference:
+
+\code
+// models HomogeneousPixel
+template <typename ChannelReference, typename ColorSpace> struct planar_pixel_reference;
+
+// Define the type of a mutable and read-only reference. (These typedefs are already provided by GIL)
+typedef planar_pixel_reference< bits8&,rgb_t> rgb8_planar_ref_t;
+typedef planar_pixel_reference<const bits8&,rgb_t> rgb8c_planar_ref_t;
+\endcode
+
+Note that, unlike the \p pixel struct, planar pixel references are templated over the color space, not over the pixel layout. They always
+use a cannonical channel ordering. Ordering of their elements is unnecessary because their elements are references to the channels.
+
+Sometimes the channels of a pixel may not be byte-aligned. For example an RGB pixel in '5-5-6' format is a 16-bit pixel whose red, green and blue
+channels occupy bits [0..4],[5..9] and [10..15] respectively. GIL provides a model for such packed pixel formats:
+
+\code
+// define an rgb565 pixel
+typedef packed_pixel_type<uint16_t, mpl::vector3_c<unsigned,5,6,5>, rgb_layout_t>::type rgb565_pixel_t;
+
+function_requires<PixelValueConcept<rgb565_pixel_t> >();
+BOOST_STATIC_ASSERT((sizeof(rgb565_pixel_t)==2));
+
+// define a bgr556 pixel
+typedef packed_pixel_type<uint16_t, mpl::vector3_c<unsigned,5,6,5>, bgr_layout_t>::type bgr556_pixel_t;
+
+function_requires<PixelValueConcept<bgr556_pixel_t> >();
+
+// rgb565 is compatible with bgr556.
+function_requires<PixelsCompatibleConcept<rgb565_pixel_t,bgr556_pixel_t> >();
+\endcode
+
+In some cases, the pixel itself may not be byte aligned. For example, consider an RGB pixel in '2-3-2' format. Its size is 7 bits.
+GIL refers to such pixels, pixel iterators and images as "bit-aligned". Bit-aligned pixels (and images) are more complex than packed ones.
+Since packed pixels are byte-aligned, we can use a C++ reference as the reference type to a packed pixel, and a C pointer as an x_iterator
+over a row of packed pixels. For bit-aligned constructs we need a special reference proxy class (bit_aligned_pixel_reference) and iterator
+class (bit_aligned_pixel_iterator). The value type of bit-aligned pixels is a packed_pixel. Here is how to use bit_aligned pixels and pixel iterators:
+
+\code
+// Mutable reference to a BGR232 pixel
+typedef const bit_aligned_pixel_reference<unsigned char, mpl::vector3_c<unsigned,2,3,2>, bgr_layout_t, true> bgr232_ref_t;
+
+// A mutable iterator over BGR232 pixels
+typedef bit_aligned_pixel_iterator<bgr232_ref_t> bgr232_ptr_t;
+
+// BGR232 pixel value. It is a packed_pixel of size 1 byte. (The last bit is unused)
+typedef std::iterator_traits<bgr232_ptr_t>::value_type bgr232_pixel_t;
+BOOST_STATIC_ASSERT((sizeof(bgr232_pixel_t)==1));
+
+bgr232_pixel_t red(0,0,3); // = 0RRGGGBB, = 01100000 = 0x60
+
+// a buffer of 7 bytes fits exactly 8 BGR232 pixels.
+unsigned char pix_buffer[7];
+std::fill(pix_buffer,pix_buffer+7,0);
+
+// Fill the 8 pixels with red
+bgr232_ptr_t pix_it(&pix_buffer[0],0); // start at bit 0 of the first pixel
+for (int i=0; i<8; ++i) {
+ *pix_it++ = red;
+}
+// Result: 0x60 0x30 0x11 0x0C 0x06 0x83 0xC1
+\endcode
+
+
+Algorithms:
+
+Since pixels model \p ColorBaseConcept and \p PixelBasedConcept all algorithms and metafunctions of color bases can work with them as well:
+
+\code
+// This is how to access the first semantic channel (red)
+assert(semantic_at_c<0>(rgb8) == semantic_at_c<0>(bgr8));
+
+// This is how to access the red channel by name
+assert(get_color<red_t>(rgb8) == get_color<red_t>(bgr8));
+
+// This is another way of doing it (some compilers don't like the first one)
+assert(get_color(rgb8,red_t()) == get_color(bgr8,red_t()));
+
+// This is how to use the PixelBasedConcept metafunctions
+BOOST_MPL_ASSERT(num_channels<rgb8_pixel_t>::value == 3);
+BOOST_MPL_ASSERT((is_same<channel_type<rgb8_pixel_t>::type, bits8>));
+BOOST_MPL_ASSERT((is_same<color_space_type<bgr8_pixel_t>::type, rgb_t> ));
+BOOST_MPL_ASSERT((is_same<channel_mapping_type<bgr8_pixel_t>::type, mpl::vector3_c<int,2,1,0> > ));
+
+// Pixels contain just the three channels and nothing extra
+BOOST_MPL_ASSERT(sizeof(rgb8_pixel_t)==3);
+
+rgb8_planar_ref_t ref(bgr8); // copy construction is allowed from a compatible mutable pixel type
+
+get_color<red_t>(ref) = 10; // assignment is ok because the reference is mutable
+assert(get_color<red_t>(bgr8)==10); // references modify the value they are bound to
+
+// Create a zero packed pixel and a full regular unpacked pixel.
+rgb565_pixel_t r565;
+rgb8_pixel_t rgb_full(255,255,255);
+
+// Convert all channels of the unpacked pixel to the packed one & assert the packed one is full
+get_color(r565,red_t()) = channel_convert<rgb565_channel0_t>(get_color(rgb_full,red_t()));
+get_color(r565,green_t()) = channel_convert<rgb565_channel1_t>(get_color(rgb_full,green_t()));
+get_color(r565,blue_t()) = channel_convert<rgb565_channel2_t>(get_color(rgb_full,blue_t()));
+assert(r565 == rgb565_pixel_t((uint16_t)65535));
+\endcode
+
+GIL also provides the \p color_convert algorithm to convert between pixels of different color spaces and channel types:
+
+\code
+rgb8_pixel_t red_in_rgb8(255,0,0);
+cmyk16_pixel_t red_in_cmyk16;
+color_convert(red_in_rgb8,red_in_cmyk16);
+\endcode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section PixelIteratorSectionDG 8. Pixel Iterator
+
+\section FundamentalIteratorDG Fundamental Iterator
+
+Pixel iterators are random traversal iterators whose \p value_type models \p PixelValueConcept.
+Pixel iterators provide metafunctions to determine whether they are mutable (i.e. whether they allow for modifying the pixel they refer to),
+to get the immutable (read-only) type of the iterator, and to determine whether they are plain iterators or adaptors over another pixel iterator:
+
+\code
+concept PixelIteratorConcept<RandomAccessTraversalIteratorConcept Iterator> : PixelBasedConcept<Iterator> {
+ where PixelValueConcept<value_type>;
+ typename const_iterator_type<It>::type;
+ where PixelIteratorConcept<const_iterator_type<It>::type>;
+ static const bool iterator_is_mutable<It>::type::value;
+ static const bool is_iterator_adaptor<It>::type::value; // is it an iterator adaptor
+};
+
+template <typename Iterator>
+concept MutablePixelIteratorConcept : PixelIteratorConcept<Iterator>, MutableRandomAccessIteratorConcept<Iterator> {};
+\endcode
+
+Related Concepts:
+
+- PixelIteratorConcept\<Iterator>
+- MutablePixelIteratorConcept\<Iterator>
+
+Models:
+
+A built-in pointer to pixel, \p pixel<ChannelValue,Layout>*, is GIL's model for pixel iterator over interleaved homogeneous pixels.
+Similarly, \p packed_pixel<PixelData,ChannelRefVec,Layout>* is GIL's model for an iterator over interleaved packed pixels.
+
+For planar homogeneous pixels, GIL provides the class \p planar_pixel_iterator, templated over a channel iterator and color space. Here is
+how the standard mutable and read-only planar RGB iterators over unsigned char are defined:
+
+\code
+template <typename ChannelPtr, typename ColorSpace> struct planar_pixel_iterator;
+
+// GIL provided typedefs
+typedef planar_pixel_iterator<const bits8*, rgb_t> rgb8c_planar_ptr_t;
+typedef planar_pixel_iterator< bits8*, rgb_t> rgb8_planar_ptr_t;
+\endcode
+
+\p planar_pixel_iterator also models \p HomogeneousColorBaseConcept (it subclasses from \p homogeneous_color_base) and, as a result, all color base
+algorithms apply to it. The element type of its color base is a channel iterator. For example, GIL implements \p operator++ of planar iterators approximately
+like this:
+
+\code
+template <typename T>
+struct inc : public std::unary_function<T,T> {
+ T operator()(T x) const { return ++x; }
+};
+
+template <typename ChannelPtr, typename ColorSpace>
+planar_pixel_iterator<ChannelPtr,ColorSpace>&
+planar_pixel_iterator<ChannelPtr,ColorSpace>::operator++() {
+ static_transform(*this,*this,inc<ChannelPtr>());
+ return *this;
+}
+\endcode
+
+Since \p static_transform uses compile-time recursion, incrementing an instance of \p rgb8_planar_ptr_t amounts to three pointer increments.
+GIL also uses the class bit_aligned_pixel_iterator as a model for a pixel iterator over bit-aligned pixels. Internally it keeps track of the current byte and
+the bit offset.
+
+\section IteratorAdaptorDG Iterator Adaptor
+
+Iterator adaptor is an iterator that wraps around another iterator. Its \p is_iterator_adaptor metafunction must evaluate to true, and it
+needs to provide a member method to return the base iterator, a metafunction to get its type, and a metafunction to rebind to another base iterator:
+
+\code
+concept IteratorAdaptorConcept<RandomAccessTraversalIteratorConcept Iterator> {
+ where SameType<is_iterator_adaptor<Iterator>::type, mpl::true_>;
+
+ typename iterator_adaptor_get_base<Iterator>;
+ where Metafunction<iterator_adaptor_get_base<Iterator> >;
+ where boost_concepts::ForwardTraversalConcept<iterator_adaptor_get_base<Iterator>::type>;
+
+ typename another_iterator;
+ typename iterator_adaptor_rebind<Iterator,another_iterator>::type;
+ where boost_concepts::ForwardTraversalConcept<another_iterator>;
+ where IteratorAdaptorConcept<iterator_adaptor_rebind<Iterator,another_iterator>::type>;
+
+ const iterator_adaptor_get_base<Iterator>::type& Iterator::base() const;
+};
+
+template <boost_concepts::Mutable_ForwardIteratorConcept Iterator>
+concept MutableIteratorAdaptorConcept : IteratorAdaptorConcept<Iterator> {};
+\endcode
+
+Related Concepts:
+
+- IteratorAdaptorConcept\<Iterator>
+- MutableIteratorAdaptorConcept\<Iterator>
+
+Models:
+
+GIL provides several models of IteratorAdaptorConcept:
+- \p memory_based_step_iterator\<Iterator>: An iterator adaptor that changes the fundamental step of the base iterator (see \ref StepIteratorDG)
+- \p dereference_iterator_adaptor\<Iterator,Fn>: An iterator that applies a unary function \p Fn upon dereferencing. It is used, for example,
+for on-the-fly color conversion. It can be used to construct a shallow image "view" that pretends to have a different color space or
+channel depth. See \ref ImageViewFrowImageViewDG for more. The unary function \p Fn must model \p PixelDereferenceAdaptorConcept (see below).
+
+\section PixelDereferenceAdaptorAG Pixel Dereference Adaptor
+
+Pixel dereference adaptor is a unary function that can be applied upon dereferencing a pixel iterator. Its argument type could be anything
+(usually a \p PixelConcept) and the result type must be convertible to \p PixelConcept
+
+\code
+template <boost::UnaryFunctionConcept D>
+concept PixelDereferenceAdaptorConcept : DefaultConstructibleConcept<D>, CopyConstructibleConcept<D>, AssignableConcept<D> {
+ typename const_t; where PixelDereferenceAdaptorConcept<const_t>;
+ typename value_type; where PixelValueConcept<value_type>;
+ typename reference; where PixelConcept<remove_reference<reference>::type>; // may be mutable
+ typename const_reference; // must not be mutable
+ static const bool D::is_mutable;
+
+ where Convertible<value_type, result_type>;
+};
+\endcode
+
+Models:
+
+GIL provides several models of \p PixelDereferenceAdaptorConcept
+ - \p color_convert_deref_fn: a function object that performs color conversion
+ - \p detail::nth_channel_deref_fn: a function object that returns a grayscale pixel corresponding to the n-th channel of a given pixel
+ - \p deref_compose: a function object that composes two models of \p PixelDereferenceAdaptorConcept. Similar to \p std::unary_compose, except
+ it needs to pull the additional typedefs required by \p PixelDereferenceAdaptorConcept
+
+GIL uses pixel dereference adaptors to implement image views that perform color conversion upon dereferencing, or that return the N-th channel of the
+underlying pixel. They can be used to model virtual image views that perform an arbitrary function upon dereferencing, for example a view of
+the Mandelbrot set. \p dereference_iterator_adaptor<Iterator,Fn> is an iterator wrapper over a pixel iterator \p Iterator that invokes the given dereference
+iterator adaptor \p Fn upon dereferencing.
+
+\section StepIteratorDG Step Iterator
+
+Sometimes we want to traverse pixels with a unit step other than the one provided by the fundamental pixel iterators.
+Examples where this would be useful:
+- a single-channel view of the red channel of an RGB interleaved image
+- left-to-right flipped image (step = -fundamental_step)
+- subsampled view, taking every N-th pixel (step = N*fundamental_step)
+- traversal in vertical direction (step = number of bytes per row)
+- any combination of the above (steps are multiplied)
+
+Step iterators are forward traversal iterators that allow changing the step between adjacent values:
+
+\code
+concept StepIteratorConcept<boost_concepts::ForwardTraversalConcept Iterator> {
+ template <Integral D> void Iterator::set_step(D step);
+};
+
+concept MutableStepIteratorConcept<boost_concepts::Mutable_ForwardIteratorConcept Iterator> : StepIteratorConcept<Iterator> {};
+\endcode
+
+GIL currently provides a step iterator whose \p value_type models \p PixelValueConcept. In addition, the step is specified in memory units (which are bytes or bits).
+This is necessary, for example, when implementing an iterator navigating along a column of pixels - the size of a row of pixels
+may sometimes not be divisible by the size of a pixel; for example rows may be word-aligned.
+
+To advance in bytes/bits, the base iterator must model MemoryBasedIteratorConcept. A memory-based iterator has an inherent memory unit, which is either a bit or a byte.
+It must supply functions returning the number of bits per memory unit (1 or 8), the current step in memory units,
+the memory-unit distance between two iterators, and a reference a given distance in memunits away. It must also supply a function that advances an iterator
+a given distance in memory units.
+ \p memunit_advanced and \p memunit_advanced_ref have a default implementation but some iterators may supply a more efficient version:
+
+\code
+concept MemoryBasedIteratorConcept<boost_concepts::RandomAccessTraversalConcept Iterator> {
+ typename byte_to_memunit<Iterator>; where metafunction<byte_to_memunit<Iterator> >;
+ std::ptrdiff_t memunit_step(const Iterator&);
+ std::ptrdiff_t memunit_distance(const Iterator& , const Iterator&);
+ void memunit_advance(Iterator&, std::ptrdiff_t diff);
+ Iterator memunit_advanced(const Iterator& p, std::ptrdiff_t diff) { Iterator tmp; memunit_advance(tmp,diff); return tmp; }
+ Iterator::reference memunit_advanced_ref(const Iterator& p, std::ptrdiff_t diff) { return *memunit_advanced(p,diff); }
+};
+
+\endcode
+
+It is useful to be able to construct a step iterator over another iterator. More generally, given a type, we want to be able to construct an equivalent
+type that allows for dynamically specified horizontal step:
+
+\code
+concept HasDynamicXStepTypeConcept<typename T> {
+ typename dynamic_x_step_type<T>;
+ where Metafunction<dynamic_x_step_type<T> >;
+};
+\endcode
+
+All models of pixel iterators, locators and image views that GIL provides support \p HasDynamicXStepTypeConcept.
+
+Related Concepts:
+
+- StepIteratorConcept\<Iterator>
+- MutableStepIteratorConcept\<Iterator>
+- MemoryBasedIteratorConcept\<Iterator>
+- HasDynamicXStepTypeConcept\<T>
+
+Models:
+
+All standard memory-based iterators GIL currently provides model \p MemoryBasedIteratorConcept.
+GIL provides the class \p memory_based_step_iterator which models \p PixelIteratorConcept, \p StepIteratorConcept, and \p MemoryBasedIteratorConcept.
+It takes the base iterator as a template parameter (which must model \p PixelIteratorConcept and \p MemoryBasedIteratorConcept)
+and allows changing the step dynamically. GIL's implementation contains the base iterator and a \p ptrdiff_t denoting the number of memory units (bytes or bits)
+to skip for a unit step. It may also be used with a negative number. GIL provides a function to create a step iterator from a base iterator and a step:
+
+\code
+template <typename I> // Models MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept
+typename dynamic_x_step_type::type make_step_iterator(const I& it, std::ptrdiff_t step);
+\endcode
+
+GIL also provides a model of an iterator over a virtual array of pixels, \p position_iterator. It is a step iterator that keeps track of the pixel position
+and invokes a function object to get the value of the pixel upon dereferencing. It models \p PixelIteratorConcept and \p StepIteratorConcept but
+not \p MemoryBasedIteratorConcept.
+
+\section LocatorDG Pixel Locator
+
+A Locator allows for navigation in two or more dimensions. Locators are N-dimensional iterators in spirit, but we use a different
+name because they don't satisfy all the requirements of iterators. For example, they don't supply increment and decrement operators because it is unclear
+which dimension the operators should advance along.
+N-dimensional locators model the following concept:
+
+\code
+concept RandomAccessNDLocatorConcept<Regular Loc> {
+ typename value_type; // value over which the locator navigates
+ typename reference; // result of dereferencing
+ typename difference_type; where PointNDConcept<difference_type>; // return value of operator-.
+ typename const_t; // same as Loc, but operating over immutable values
+ typename cached_location_t; // type to store relative location (for efficient repeated access)
+ typename point_t = difference_type;
+
+ static const size_t num_dimensions; // dimensionality of the locator
+ where num_dimensions = point_t::num_dimensions;
+
+ // The difference_type and iterator type along each dimension. The iterators may only differ in
+ // difference_type. Their value_type must be the same as Loc::value_type
+ template <size_t D> struct axis {
+ typename coord_t = point_t::axis<D>::coord_t;
+ typename iterator; where RandomAccessTraversalConcept<iterator>; // iterator along D-th axis.
+ where iterator::value_type == value_type;
+ };
+
+ // Defines the type of a locator similar to this type, except it invokes Deref upon dereferencing
+ template <PixelDereferenceAdaptorConcept Deref> struct add_deref {
+ typename type; where RandomAccessNDLocatorConcept<type>;
+ static type make(const Loc& loc, const Deref& deref);
+ };
+
+ Loc& operator+=(Loc&, const difference_type&);
+ Loc& operator-=(Loc&, const difference_type&);
+ Loc operator+(const Loc&, const difference_type&);
+ Loc operator-(const Loc&, const difference_type&);
+
+ reference operator*(const Loc&);
+ reference operator[](const Loc&, const difference_type&);
+
+ // Storing relative location for faster repeated access and accessing it
+ cached_location_t Loc::cache_location(const difference_type&) const;
+ reference operator[](const Loc&,const cached_location_t&);
+
+ // Accessing iterators along a given dimension at the current location or at a given offset
+ template <size_t D> axis<D>::iterator& Loc::axis_iterator();
+ template <size_t D> axis<D>::iterator const& Loc::axis_iterator() const;
+ template <size_t D> axis<D>::iterator Loc::axis_iterator(const difference_type&) const;
+};
+
+template <typename Loc>
+concept MutableRandomAccessNDLocatorConcept : RandomAccessNDLocatorConcept<Loc> {
+ where Mutable<reference>;
+};
+\endcode
+
+Two-dimensional locators have additional requirements:
+
+\code
+concept RandomAccess2DLocatorConcept<RandomAccessNDLocatorConcept Loc> {
+ where num_dimensions==2;
+ where Point2DConcept<point_t>;
+
+ typename x_iterator = axis<0>::iterator;
+ typename y_iterator = axis<1>::iterator;
+ typename x_coord_t = axis<0>::coord_t;
+ typename y_coord_t = axis<1>::coord_t;
+
+ // Only available to locators that have dynamic step in Y
+ //Loc::Loc(const Loc& loc, y_coord_t);
+
+ // Only available to locators that have dynamic step in X and Y
+ //Loc::Loc(const Loc& loc, x_coord_t, y_coord_t, bool transposed=false);
+
+ x_iterator& Loc::x();
+ x_iterator const& Loc::x() const;
+ y_iterator& Loc::y();
+ y_iterator const& Loc::y() const;
+
+ x_iterator Loc::x_at(const difference_type&) const;
+ y_iterator Loc::y_at(const difference_type&) const;
+ Loc Loc::xy_at(const difference_type&) const;
+
+ // x/y versions of all methods that can take difference type
+ x_iterator Loc::x_at(x_coord_t, y_coord_t) const;
+ y_iterator Loc::y_at(x_coord_t, y_coord_t) const;
+ Loc Loc::xy_at(x_coord_t, y_coord_t) const;
+ reference operator()(const Loc&, x_coord_t, y_coord_t);
+ cached_location_t Loc::cache_location(x_coord_t, y_coord_t) const;
+
+ bool Loc::is_1d_traversable(x_coord_t width) const;
+ y_coord_t Loc::y_distance_to(const Loc& loc2, x_coord_t x_diff) const;
+};
+
+concept MutableRandomAccess2DLocatorConcept<RandomAccess2DLocatorConcept Loc> : MutableRandomAccessNDLocatorConcept<Loc> {};
+\endcode
+
+2D locators can have a dynamic step not just horizontally, but also vertically. This gives rise to the Y equivalent of \p HasDynamicXStepTypeConcept:
+
+\code
+concept HasDynamicYStepTypeConcept<typename T> {
+ typename dynamic_y_step_type<T>;
+ where Metafunction<dynamic_y_step_type<T> >;
+};
+\endcode
+
+All locators and image views that GIL provides model \p HasDynamicYStepTypeConcept.
+
+Sometimes it is necessary to swap the meaning of X and Y for a given locator or image view type (for example, GIL provides a function to transpose an image view).
+Such locators and views must be transposable:
+
+\code
+concept HasTransposedTypeConcept<typename T> {
+ typename transposed_type<T>;
+ where Metafunction<transposed_type<T> >;
+};
+\endcode
+
+All GIL provided locators and views model \p HasTransposedTypeConcept.
+
+The locators GIL uses operate over models of \p PixelConcept and their x and y dimension types are the same. They model the following concept:
+
+\code
+concept PixelLocatorConcept<RandomAccess2DLocatorConcept Loc> {
+ where PixelValueConcept<value_type>;
+ where PixelIteratorConcept<x_iterator>;
+ where PixelIteratorConcept<y_iterator>;
+ where x_coord_t == y_coord_t;
+
+ typename coord_t = x_coord_t;
+};
+
+concept MutablePixelLocatorConcept<PixelLocatorConcept Loc> : MutableRandomAccess2DLocatorConcept<Loc> {};
+\endcode
+
+Related Concepts:
+
+- HasDynamicYStepTypeConcept\<T>
+- HasTransposedTypeConcept\<T>
+- RandomAccessNDLocatorConcept\<Locator>
+- MutableRandomAccessNDLocatorConcept\<Locator>
+- RandomAccess2DLocatorConcept\<Locator>
+- MutableRandomAccess2DLocatorConcept\<Locator>
+- PixelLocatorConcept\<Locator>
+- MutablePixelLocatorConcept\<Locator>
+
+Models:
+
+GIL provides two models of \p PixelLocatorConcept - a memory-based locator, \p memory_based_2d_locator and a virtual locator \p virtual_2d_locator.
+
+\p memory_based_2d_locator is a locator over planar or interleaved images that have their pixels in memory.
+It takes a model of \p StepIteratorConcept over pixels as a template parameter. (When instantiated with a model of \p MutableStepIteratorConcept,
+it models \p MutablePixelLocatorConcept).
+
+\code
+template <typename StepIterator> // Models StepIteratorConcept, MemoryBasedIteratorConcept
+class memory_based_2d_locator;
+\endcode
+
+The step of \p StepIterator must be the number of memory units (bytes or bits) per row (thus it must be memunit advanceable). The class \p memory_based_2d_locator is a
+wrapper around \p StepIterator and uses it to navigate vertically, while its base iterator is used to navigate horizontally.
+
+Combining fundamental and step iterators allows us to create locators that describe complex
+pixel memory organizations. First, we have a choice of iterator to use for horizontal direction, i.e. for iterating over the pixels on the same row.
+Using the fundamental and step iterators gives us four choices:
+- \p pixel<T,C>* (for interleaved images)
+- \p planar_pixel_iterator<T*,C> (for planar images)
+- \p memory_based_step_iterator<pixel<T,C>*> (for interleaved images with non-standard step)
+- <tt> memory_based_step_iterator<planar_pixel_iterator<T*,C> > </tt> (for planar images with non-standard step)
+
+Of course, one could provide their own custom x-iterator. One such example described later is an iterator adaptor that performs color
+conversion when dereferenced.
+
+Given a horizontal iterator \p XIterator, we could choose the \e y-iterator, the iterator that moves along a column, as
+\p memory_based_step_iterator<XIterator> with a step equal to the number of memory units (bytes or bits) per row. Again, one is free to provide their own y-iterator.
+
+Then we can instantiate \p memory_based_2d_locator<memory_based_step_iterator<XIterator> > to obtain a 2D pixel locator, as the diagram indicates:
+\image html step_iterator.gif
+
+\p virtual_2d_locator is a locator that is instantiated with a function object invoked upon dereferencing a pixel. It returns the value of a pixel
+given its X,Y coordiantes. Virtual locators can be used to implement virtual image views that can model any user-defined function. See the GIL
+tutorial for an example of using virtual locators to create a view of the Mandelbrot set.
+
+Both the virtual and the memory-based locators subclass from \p pixel_2d_locator_base, a base class that provides most of the interface required
+by \p PixelLocatorConcept. Users may find this base class useful if they need to provide other models of \p PixelLocatorConcept.
+
+Here is some sample code using locators:
+
+\code
+loc=img.xy_at(10,10); // start at pixel (x=10,y=10)
+above=loc.cache_location(0,-1); // remember relative locations of neighbors above and below
+below=loc.cache_location(0, 1);
+++loc.x(); // move to (11,10)
+loc.y()+=15; // move to (11,25)
+loc-=point2<std::ptrdiff_t>(1,1);// move to (10,24)
+*loc=(loc(0,-1)+loc(0,1))/2; // set pixel (10,24) to the average of (10,23) and (10,25) (grayscale pixels only)
+*loc=(loc[above]+loc[below])/2; // the same, but faster using cached relative neighbor locations
+\endcode
+
+The standard GIL locators are fast and lightweight objects. For example, the locator for a simple interleaved image consists of
+one raw pointer to the pixel location plus one integer for the row size in bytes, for a total of 8 bytes. <tt> ++loc.x() </tt> amounts to
+incrementing a raw pointer (or N pointers for planar images). Computing 2D offsets is slower as it requires multiplication and addition.
+Filters, for example, need to access the same neighbors for every pixel in the image, in which case the relative positions can be cached
+into a raw byte difference using \p cache_location. In the above example <tt> loc[above]</tt> for simple interleaved images amounts to a raw array
+index operator.
+
+\section IteratorFrom2DDG Iterator over 2D image
+
+Sometimes we want to perform the same, location-independent operation over all pixels of an image. In such a case it is useful to represent the pixels
+as a one-dimensional array. GIL's \p iterator_from_2d is a random access traversal iterator that visits all pixels in an image in the natural
+memory-friendly order left-to-right inside top-to-bottom. It takes a locator, the width of the image and the current X position. This is sufficient
+information for it to determine when to do a "carriage return". Synopsis:
+
+\code
+template <typename Locator> // Models PixelLocatorConcept
+class iterator_from_2d {
+public:
+ iterator_from_2d(const Locator& loc, int x, int width);
+
+ iterator_from_2d& operator++(); // if (++_x<_width) ++_p.x(); else _p+=point_t(-_width,1);
+
+ ...
+private:
+ int _x, _width;
+ Locator _p;
+};
+\endcode
+
+Iterating through the pixels in an image using \p iterator_from_2d is slower than going through all rows and using the x-iterator at each row.
+This is because two comparisons are done per iteration step - one for the end condition of the loop using the iterators, and one inside
+\p iterator_from_2d::operator++ to determine whether we are at the end of a row. For fast operations, such as pixel copy, this second check
+adds about 15% performance delay (measured for interleaved images on Intel platform). GIL overrides some STL algorithms, such as \p std::copy and
+\p std::fill, when invoked with \p iterator_from_2d-s, to go through each row using their base x-iterators, and, if the image has no padding
+(i.e. \p iterator_from_2d::is_1d_traversable() returns true) to simply iterate using the x-iterators directly.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section ImageViewSectionDG 9. Image View
+
+An image view is a generalization of STL's range concept to multiple dimensions. Similar to ranges (and iterators), image views are shallow, don't
+own the underlying data and don't propagate their constness over the data. For example, a constant image view cannot be resized, but may allow
+modifying the pixels. For pixel-immutable operations, use constant-value image view (also called non-mutable image view).
+Most general N-dimensional views satisfy the following concept:
+
+\code
+concept RandomAccessNDImageViewConcept<Regular View> {
+ typename value_type; // for pixel-based views, the pixel type
+ typename reference; // result of dereferencing
+ typename difference_type; // result of operator-(iterator,iterator) (1-dimensional!)
+ typename const_t; where RandomAccessNDImageViewConcept<View>; // same as View, but over immutable values
+ typename point_t; where PointNDConcept<point_t>; // N-dimensional point
+ typename locator; where RandomAccessNDLocatorConcept<locator>; // N-dimensional locator.
+ typename iterator; where RandomAccessTraversalConcept<iterator>; // 1-dimensional iterator over all values
+ typename reverse_iterator; where RandomAccessTraversalConcept<reverse_iterator>;
+ typename size_type; // the return value of size()
+
+ // Equivalent to RandomAccessNDLocatorConcept::axis
+ template <size_t D> struct axis {
+ typename coord_t = point_t::axis<D>::coord_t;
+ typename iterator; where RandomAccessTraversalConcept<iterator>; // iterator along D-th axis.
+ where SameType<coord_t, iterator::difference_type>;
+ where SameType<iterator::value_type,value_type>;
+ };
+
+ // Defines the type of a view similar to this type, except it invokes Deref upon dereferencing
+ template <PixelDereferenceAdaptorConcept Deref> struct add_deref {
+ typename type; where RandomAccessNDImageViewConcept<type>;
+ static type make(const View& v, const Deref& deref);
+ };
+
+ static const size_t num_dimensions = point_t::num_dimensions;
+
+ // Create from a locator at the top-left corner and dimensions
+ View::View(const locator&, const point_type&);
+
+ size_type View::size() const; // total number of elements
+ reference operator[](View, const difference_type&) const; // 1-dimensional reference
+ iterator View::begin() const;
+ iterator View::end() const;
+ reverse_iterator View::rbegin() const;
+ reverse_iterator View::rend() const;
+ iterator View::at(const point_t&);
+ point_t View::dimensions() const; // number of elements along each dimension
+ bool View::is_1d_traversable() const; // Does an iterator over the first dimension visit each value?
+
+ // iterator along a given dimension starting at a given point
+ template <size_t D> View::axis<D>::iterator View::axis_iterator(const point_t&) const;
+
+ reference operator()(View,const point_t&) const;
+};
+
+concept MutableRandomAccessNDImageViewConcept<RandomAccessNDImageViewConcept View> {
+ where Mutable<reference>;
+};
+\endcode
+
+Two-dimensional image views have the following extra requirements:
+
+\code
+concept RandomAccess2DImageViewConcept<RandomAccessNDImageViewConcept View> {
+ where num_dimensions==2;
+
+ typename x_iterator = axis<0>::iterator;
+ typename y_iterator = axis<1>::iterator;
+ typename x_coord_t = axis<0>::coord_t;
+ typename y_coord_t = axis<1>::coord_t;
+ typename xy_locator = locator;
+
+ x_coord_t View::width() const;
+ y_coord_t View::height() const;
+
+ // X-navigation
+ x_iterator View::x_at(const point_t&) const;
+ x_iterator View::row_begin(y_coord_t) const;
+ x_iterator View::row_end (y_coord_t) const;
+
+ // Y-navigation
+ y_iterator View::y_at(const point_t&) const;
+ y_iterator View::col_begin(x_coord_t) const;
+ y_iterator View::col_end (x_coord_t) const;
+
+ // navigating in 2D
+ xy_locator View::xy_at(const point_t&) const;
+
+ // (x,y) versions of all methods taking point_t
+ View::View(x_coord_t,y_coord_t,const locator&);
+ iterator View::at(x_coord_t,y_coord_t) const;
+ reference operator()(View,x_coord_t,y_coord_t) const;
+ xy_locator View::xy_at(x_coord_t,y_coord_t) const;
+ x_iterator View::x_at(x_coord_t,y_coord_t) const;
+ y_iterator View::y_at(x_coord_t,y_coord_t) const;
+};
+
+concept MutableRandomAccess2DImageViewConcept<RandomAccess2DImageViewConcept View>
+ : MutableRandomAccessNDImageViewConcept<View> {};
+\endcode
+
+Image views that GIL typically uses operate on value types that model \p PixelValueConcept and have some additional requirements:
+
+\code
+concept ImageViewConcept<RandomAccess2DImageViewConcept View> {
+ where PixelValueConcept<value_type>;
+ where PixelIteratorConcept<x_iterator>;
+ where PixelIteratorConcept<y_iterator>;
+ where x_coord_t == y_coord_t;
+
+ typename coord_t = x_coord_t;
+
+ std::size_t View::num_channels() const;
+};
+
+
+concept MutableImageViewConcept<ImageViewConcept View> : MutableRandomAccess2DImageViewConcept<View> {};
+\endcode
+
+Two image views are compatible if they have compatible pixels and the same number of dimensions:
+\code
+concept ViewsCompatibleConcept<ImageViewConcept V1, ImageViewConcept V2> {
+ where PixelsCompatibleConcept<V1::value_type, V2::value_type>;
+ where V1::num_dimensions == V2::num_dimensions;
+};
+\endcode
+
+Compatible views must also have the same dimensions (i.e. the same width and height). Many algorithms taking multiple views require that they be pairwise compatible.
+
+Related Concepts:
+
+- RandomAccessNDImageViewConcept\<View>
+- MutableRandomAccessNDImageViewConcept\<View>
+- RandomAccess2DImageViewConcept\<View>
+- MutableRandomAccess2DImageViewConcept\<View>
+- ImageViewConcept\<View>
+- MutableImageViewConcept\<View>
+- ViewsCompatibleConcept\<View1,View2>
+
+Models:
+
+GIL provides a model for \p ImageViewConcept called \p image_view. It is templated over a model of \p PixelLocatorConcept.
+(If instantiated with a model of \p MutablePixelLocatorConcept, it models \p MutableImageViewConcept). Synopsis:
+
+\code
+template <typename Locator> // Models PixelLocatorConcept (could be MutablePixelLocatorConcept)
+class image_view {
+public:
+ typedef Locator xy_locator;
+ typedef iterator_from_2d<Locator> iterator;
+ ...
+private:
+ xy_locator _pixels; // 2D pixel locator at the top left corner of the image view range
+ point_t _dimensions; // width and height
+};
+\endcode
+
+Image views are lightweight objects. A regular interleaved view is typically 16 bytes long - two integers for the width and height (inside dimensions)
+one for the number of bytes between adjacent rows (inside the locator) and one pointer to the beginning of the pixel block.
+
+Algorithms:
+
+\subsection ImageViewFrowRawDG Creating Views from Raw Pixels
+
+Standard image views can be constructed from raw data of any supported color space, bit depth, channel ordering or planar vs. interleaved structure.
+Interleaved views are constructed using \p interleaved_view, supplying the image dimensions, number of bytes per row, and a
+pointer to the first pixel:
+
+\code
+template <typename Iterator> // Models pixel iterator (like rgb8_ptr_t or rgb8c_ptr_t)
+image_view<...> interleaved_view(ptrdiff_t width, ptrdiff_t height, Iterator pixels, ptrdiff_t rowsize)
+\endcode
+
+Planar views are defined for every color space and take each plane separately. Here is the RGB one:
+
+\code
+template <typename IC> // Models channel iterator (like bits8* or const bits8*)
+image_view<...> planar_rgb_view(ptrdiff_t width, ptrdiff_t height,
+ IC r, IC g, IC b, ptrdiff_t rowsize);
+\endcode
+
+Note that the supplied pixel/channel iterators could be constant (read-only), in which case the returned view is a constant-value (immutable) view.
+
+\subsection ImageViewFrowImageViewDG Creating Image Views from Other Image Views
+
+It is possible to construct one image view from another by changing some policy of how image data is interpreted. The result could be a view whose type is
+derived from the type of the source. GIL uses the following metafunctions to get the derived types:
+
+\code
+
+// Some result view types
+template <typename View>
+struct dynamic_xy_step_type : public dynamic_y_step_type<typename dynamic_x_step_type<View>::type> {};
+
+template <typename View>
+struct dynamic_xy_step_transposed_type : public dynamic_xy_step_type<typename transposed_type<View>::type> {};
+
+// color and bit depth converted view to match pixel type P
+template <typename SrcView, // Models ImageViewConcept
+ typename DstP, // Models PixelConcept
+ typename ColorConverter=gil::default_color_converter>
+struct color_converted_view_type {
+ typedef ... type; // image view adaptor with value type DstP, over SrcView
+};
+
+// single-channel view of the N-th channel of a given view
+template <typename SrcView>
+struct nth_channel_view_type {
+ typedef ... type;
+};
+\endcode
+
+GIL Provides the following view transformations:
+
+\code
+// flipped upside-down, left-to-right, transposed view
+template <typename View> typename dynamic_y_step_type<View>::type flipped_up_down_view(const View& src);
+template <typename View> typename dynamic_x_step_type<View>::type flipped_left_right_view(const View& src);
+template <typename View> typename dynamic_xy_step_transposed_type<View>::type transposed_view(const View& src);
+
+// rotations
+template <typename View> typename dynamic_xy_step_type<View>::type rotated180_view(const View& src);
+template <typename View> typename dynamic_xy_step_transposed_type<View>::type rotated90cw_view(const View& src);
+template <typename View> typename dynamic_xy_step_transposed_type<View>::type rotated90ccw_view(const View& src);
+
+// view of an axis-aligned rectangular area within an image
+template <typename View> View subimage_view(const View& src,
+ const View::point_t& top_left, const View::point_t& dimensions);
+
+// subsampled view (skipping pixels in X and Y)
+template <typename View> typename dynamic_xy_step_type<View>::type subsampled_view(const View& src,
+ const View::point_t& step);
+
+template <typename View, typename P>
+color_converted_view_type<View,P>::type color_converted_view(const View& src);
+template <typename View, typename P, typename CCV> // with a custom color converter
+color_converted_view_type<View,P,CCV>::type color_converted_view(const View& src);
+
+template <typename View>
+nth_channel_view_type<View>::view_t nth_channel_view(const View& view, int n);
+\endcode
+
+The implementations of most of these view factory methods are straightforward. Here is, for example, how the flip views are implemented.
+The flip upside-down view creates a view whose first pixel is the bottom left pixel of the original view and whose y-step is the negated
+step of the source.
+
+\code
+template <typename View>
+typename dynamic_y_step_type<View>::type flipped_up_down_view(const View& src) {
+ gil_function_requires<ImageViewConcept<View> >();
+ typedef typename dynamic_y_step_type<View>::type RView;
+ return RView(src.dimensions(),typename RView::xy_locator(src.xy_at(0,src.height()-1),-1));
+}
+\endcode
+
+The call to \p gil_function_requires ensures (at compile time) that the template parameter is a valid model of \p ImageViewConcept. Using it
+generates easier to track compile errors, creates no extra code and has no run-time performance impact.
+We are using the \p boost::concept_check library, but wrapping it in \p gil_function_requires, which performs the check if the \p BOOST_GIL_USE_CONCEPT_CHECK
+is set. It is unset by default, because there is a significant increase in compile time when using concept checks. We will skip \p gil_function_requires
+in the code examples in this guide for the sake of succinctness.
+
+Image views can be freely composed (see section \ref MetafunctionsDG for the typedefs \p rgb16_image_t and \p gray16_step_view_t):
+
+\code
+rgb16_image_t img(100,100); // an RGB interleaved image
+
+// grayscale view over the green (index 1) channel of img
+gray16_step_view_t green=nth_channel_view(view(img),1);
+
+// 50x50 view of the green channel of img, upside down and taking every other pixel in X and in Y
+gray16_step_view_t ud_fud=flipped_up_down_view(subsampled_view(green,2,2));
+\endcode
+
+As previously stated, image views are fast, constant-time, shallow views over the pixel data. The above code does not copy any pixels; it operates
+on the pixel data allocated when \p img was created.
+
+\subsection ImageViewAlgorithmsDG STL-Style Algorithms on Image Views
+
+Image views provide 1D iteration of their pixels via begin() and end() methods, which makes it possible to use STL
+algorithms with them. However, using nested loops over X and Y is in many cases more efficient. The algorithms in this
+section resemble STL algorithms, but they abstract away the nested loops and take views (as opposed to ranges) as input.
+
+\code
+// Equivalents of std::copy and std::uninitialized_copy
+// where ImageViewConcept<V1>, MutableImageViewConcept<V2>, ViewsCompatibleConcept<V1,V2>
+template <typename V1, typename V2>
+void copy_pixels(const V1& src, const V2& dst);
+template <typename V1, typename V2>
+void uninitialized_copy_pixels(const V1& src, const V2& dst);
+
+// Equivalents of std::fill and std::uninitialized_fill
+// where MutableImageViewConcept<V>, PixelConcept<Value>, PixelsCompatibleConcept<Value,V::value_type>
+template <typename V, typename Value>
+void fill_pixels(const V& dst, const Value& val);
+template <typename V, typename Value>
+void uninitialized_fill_pixels(const V& dst, const Value& val);
+
+// Equivalent of std::for_each
+// where ImageViewConcept<V>, boost::UnaryFunctionConcept<F>
+// where PixelsCompatibleConcept<V::reference, F::argument_type>
+template <typename V, typename F>
+F for_each_pixel(const V& view, F fun);
+template <typename V, typename F>
+F for_each_pixel_position(const V& view, F fun);
+
+// Equivalent of std::generate
+// where MutableImageViewConcept<V>, boost::UnaryFunctionConcept<F>
+// where PixelsCompatibleConcept<V::reference, F::argument_type>
+template <typename V, typename F>
+void generate_pixels(const V& dst, F fun);
+
+// Equivalent of std::transform with one source
+// where ImageViewConcept<V1>, MutableImageViewConcept<V2>
+// where boost::UnaryFunctionConcept<F>
+// where PixelsCompatibleConcept<V1::const_reference, F::argument_type>
+// where PixelsCompatibleConcept<F::result_type, V2::reference>
+template <typename V1, typename V2, typename F>
+F transform_pixels(const V1& src, const V2& dst, F fun);
+template <typename V1, typename V2, typename F>
+F transform_pixel_positions(const V1& src, const V2& dst, F fun);
+
+// Equivalent of std::transform with two sources
+// where ImageViewConcept<V1>, ImageViewConcept<V2>, MutableImageViewConcept<V3>
+// where boost::BinaryFunctionConcept<F>
+// where PixelsCompatibleConcept<V1::const_reference, F::first_argument_type>
+// where PixelsCompatibleConcept<V2::const_reference, F::second_argument_type>
+// where PixelsCompatibleConcept<F::result_type, V3::reference>
+template <typename V1, typename V2, typename V3, typename F>
+F transform_pixels(const V1& src1, const V2& src2, const V3& dst, F fun);
+template <typename V1, typename V2, typename V3, typename F>
+F transform_pixel_positions(const V1& src1, const V2& src2, const V3& dst, F fun);
+
+// Copies a view into another, color converting the pixels if needed, with the default or user-defined color converter
+// where ImageViewConcept<V1>, MutableImageViewConcept<V2>
+// V1::value_type must be convertible to V2::value_type.
+template <typename V1, typename V2>
+void copy_and_convert_pixels(const V1& src, const V2& dst);
+template <typename V1, typename V2, typename ColorConverter>
+void copy_and_convert_pixels(const V1& src, const V2& dst, ColorConverter ccv);
+
+// Equivalent of std::equal
+// where ImageViewConcept<V1>, ImageViewConcept<V2>, ViewsCompatibleConcept<V1,V2>
+template <typename V1, typename V2>
+bool equal_pixels(const V1& view1, const V2& view2);
+\endcode
+
+Algorithms that take multiple views require that they have the same dimensions.
+\p for_each_pixel_position and \p transform_pixel_positions pass pixel locators, as opposed to pixel references, to their function objects.
+This allows for writing algorithms that use pixel neighbors, as the tutorial demonstrates.
+
+Most of these algorithms check whether the image views are 1D-traversable. A 1D-traversable image view has no gaps at the end of the rows.
+In other words, if an x_iterator of that view is advanced past the last pixel in a row it will move to the first pixel of the next row.
+When image views are 1D-traversable, the algorithms use a single loop and run more efficiently. If one or more of the input views are not
+1D-traversable, the algorithms fall-back to an X-loop nested inside a Y-loop.
+
+The algorithms typically delegate the work to their corresponding STL algorithms. For example, \p copy_pixels calls \p std::copy either for each
+row, or, when the images are 1D-traversable, once for all pixels.
+
+In addition, overloads are sometimes provided for the STL algorithms. For example, \p std::copy for planar iterators is overloaded to perform
+\p std::copy for each of the planes. \p std::copy over bitwise-copiable pixels results in \p std::copy over unsigned char, which STL typically
+implements via \p memmove.
+
+As a result \p copy_pixels may result in a single call to \p memmove for interleaved 1D-traversable views, or one per each plane of planar
+1D-traversable views, or one per each row of interleaved non-1D-traversable images, etc.
+
+GIL also provides some beta-versions of image processing algorithms, such as resampling and convolution in a numerics extension available on
+http://stlab.adobe.com/gil/download.html. This code is in early stage of development and is not optimized for speed
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<hr>
+\section ImageSectionDG 10. Image
+
+An image is a container that owns the pixels of a given image view. It allocates them in its constructor and deletes
+them in the destructor. It has a deep assignment operator and copy constructor. Images are used rarely, just when
+data ownership is important. Most STL algorithms operate on ranges, not containers. Similarly most GIL algorithms operate on image
+views (which images provide).
+
+In the most general form images are N-dimensional and satisfy the following concept:
+
+\code
+concept RandomAccessNDImageConcept<typename Img> : Regular<Img> {
+ typename view_t; where MutableRandomAccessNDImageViewConcept<view_t>;
+ typename const_view_t = view_t::const_t;
+ typename point_t = view_t::point_t;
+ typename value_type = view_t::value_type;
+ typename allocator_type;
+
+ Img::Img(point_t dims, std::size_t alignment=0);
+ Img::Img(point_t dims, value_type fill_value, std::size_t alignment);
+
+ void Img::recreate(point_t new_dims, std::size_t alignment=0);
+ void Img::recreate(point_t new_dims, value_type fill_value, std::size_t alignment);
+
+ const point_t& Img::dimensions() const;
+ const const_view_t& const_view(const Img&);
+ const view_t& view(Img&);
+};
+\endcode
+
+Two-dimensional images have additional requirements:
+
+\code
+concept RandomAccess2DImageConcept<RandomAccessNDImageConcept Img> {
+ typename x_coord_t = const_view_t::x_coord_t;
+ typename y_coord_t = const_view_t::y_coord_t;
+
+ Img::Img(x_coord_t width, y_coord_t height, std::size_t alignment=0);
+ Img::Img(x_coord_t width, y_coord_t height, value_type fill_value, std::size_t alignment);
+
+ x_coord_t Img::width() const;
+ y_coord_t Img::height() const;
+
+ void Img::recreate(x_coord_t width, y_coord_t height, std::size_t alignment=1);
+ void Img::recreate(x_coord_t width, y_coord_t height, value_type fill_value, std::size_t alignment);
+};
+\endcode
+
+GIL's images have views that model \p ImageViewConcept and operate on pixels.
+
+\code
+concept ImageConcept<RandomAccess2DImageConcept Img> {
+ where MutableImageViewConcept<view_t>;
+ typename coord_t = view_t::coord_t;
+};
+\endcode
+
+Images, unlike locators and image views, don't have 'mutable' set of concepts because immutable images are not very useful.
+
+Related Concepts:
+
+- RandomAccessNDImageConcept\<Image>
+- RandomAccess2DImageConcept\<Image>
+- ImageConcept\<Image>
+
+Models:
+
+GIL provides a class, \p image, which is templated over the value type (the pixel) and models \p ImageConcept.
+
+\code
+template <typename Pixel, \\ Models PixelValueConcept
+ bool IsPlanar, \\ planar or interleaved image
+ typename A=std::allocator<unsigned char> >
+class image;
+\endcode
+
+The image constructor takes an alignment parameter which allows for constructing images that are word-aligned or 8-byte aligned. The alignment is specified in
+bytes. The default value for alignment is 0, which means there is no padding at the end of rows. Many operations are
+faster using such 1D-traversable images, because \p image_view::x_iterator can be used to traverse the pixels, instead of the more complicated
+\p image_view::iterator. Note that when alignment is 0, packed images are aligned to the bit - i.e. there are no padding bits at the end of rows of packed images.
+<hr>
+\section VariantSecDG 11. Run-time specified images and image views
+
+The color space, channel depth, channel ordering, and interleaved/planar structure of an image are defined by the type of its template argument, which
+makes them compile-time bound. Often some of these parameters are available only at run time.
+Consider, for example, writing a module that opens the image at a given file path, rotates it and saves it back in its original color space and channel
+depth. How can we possibly write this using our generic image? What type is the image loading code supposed to return?
+
+GIL's dynamic_image extension allows for images, image views or any GIL constructs to have their parameters defined at run time. Here is an example:
+\code
+#include <boost/gil/extension/dynamic_image/dynamic_image_all.hpp>
+using namespace boost;
+
+#define ASSERT_SAME(A,B) BOOST_STATIC_ASSERT((is_same< A,B >::value))
+
+// Define the set of allowed images
+typedef mpl::vector<rgb8_image_t, cmyk16_planar_image_t> my_images_t;
+
+// Create any_image class (or any_image_view) class
+typedef any_image<my_images_t> my_any_image_t;
+
+// Associated view types are available (equivalent to the ones in image_t)
+typedef any_image_view<mpl::vector2<rgb8_view_t, cmyk16_planar_view_t > > AV;
+ASSERT_SAME(my_any_image_t::view_t, AV);
+
+typedef any_image_view<mpl::vector2<rgb8c_view_t, cmyk16c_planar_view_t> > CAV;
+ASSERT_SAME(my_any_image_t::const_view_t, CAV);
+ASSERT_SAME(my_any_image_t::const_view_t, my_any_image_t::view_t::const_t);
+
+typedef any_image_view<mpl::vector2<rgb8_step_view_t, cmyk16_planar_step_view_t> > SAV;
+ASSERT_SAME(typename dynamic_x_step_type<my_any_image_t::view_t>::type, SAV);
+
+// Assign it a concrete image at run time:
+my_any_image_t myImg = my_any_image_t(rgb8_image_t(100,100));
+
+// Change it to another at run time. The previous image gets destroyed
+myImg = cmyk16_planar_image_t(200,100);
+
+// Assigning to an image not in the allowed set throws an exception
+myImg = gray8_image_t(); // will throw std::bad_cast
+\endcode
+
+\p any_image and \p any_image_view subclass from GIL's \p variant class, which breaks down the instantiated type
+into a non-templated underlying base type and a unique instantiation type identifier. The underlying base instance is represented
+as a block of bytes. The block is large enough to hold the largest of the specified types.
+
+GIL's variant is similar to \p boost::variant in spirit (hence we borrow the name from there) but it differs in several ways from
+the current boost implementation. Perhaps the biggest difference is that GIL's variant always takes a single argument, which is a model
+of MPL Random Access Sequence enumerating the allowed types. Having a single interface allows GIL's variant to be used easier in generic code. Synopsis:
+
+\code
+template <typename Types> // models MPL Random Access Container
+class variant {
+ ... _bits;
+ std::size_t _index;
+public:
+ typedef Types types_t;
+
+ variant();
+ variant(const variant& v);
+ virtual ~variant();
+
+ variant& operator=(const variant& v);
+ template <typename TS> friend bool operator==(const variant<TS>& x, const variant<TS>& y);
+ template <typename TS> friend bool operator!=(const variant<TS>& x, const variant<TS>& y);
+
+ // Construct/assign to type T. Throws std::bad_cast if T is not in Types
+ template <typename T> explicit variant(const T& obj);
+ template <typename T> variant& operator=(const T& obj);
+
+ // Construct/assign by swapping T with its current instance. Only possible if they are swappable
+ template <typename T> explicit variant(T& obj, bool do_swap);
+ template <typename T> void move_in(T& obj);
+
+ template <typename T> static bool has_type();
+
+ template <typename T> const T& _dynamic_cast() const;
+ template <typename T> T& _dynamic_cast();
+
+ template <typename T> bool current_type_is() const;
+};
+
+template <typename UOP, typename Types>
+ UOP::result_type apply_operation(variant<Types>& v, UOP op);
+template <typename UOP, typename Types>
+ UOP::result_type apply_operation(const variant<Types>& v, UOP op);
+
+template <typename BOP, typename Types1, typename Types2>
+ BOP::result_type apply_operation( variant<Types1>& v1, variant<Types2>& v2, UOP op);
+
+template <typename BOP, typename Types1, typename Types2>
+ BOP::result_type apply_operation(const variant<Types1>& v1, variant<Types2>& v2, UOP op);
+
+template <typename BOP, typename Types1, typename Types2>
+ BOP::result_type apply_operation(const variant<Types1>& v1, const variant<Types2>& v2, UOP op);
+\endcode
+
+GIL's \p any_image_view and \p any_image are subclasses of \p variant:
+
+\code
+template <typename ImageViewTypes>
+class any_image_view : public variant<ImageViewTypes> {
+public:
+ typedef ... const_t; // immutable equivalent of this
+ typedef std::ptrdiff_t x_coord_t;
+ typedef std::ptrdiff_t y_coord_t;
+ typedef point2<std::ptrdiff_t> point_t;
+
+ any_image_view();
+ template <typename T> explicit any_image_view(const T& obj);
+ any_image_view(const any_image_view& v);
+
+ template <typename T> any_image_view& operator=(const T& obj);
+ any_image_view& operator=(const any_image_view& v);
+
+ // parameters of the currently instantiated view
+ std::size_t num_channels() const;
+ point_t dimensions() const;
+ x_coord_t width() const;
+ y_coord_t height() const;
+};
+
+template <typename ImageTypes>
+class any_image : public variant<ImageTypes> {
+ typedef variant<ImageTypes> parent_t;
+public:
+ typedef ... const_view_t;
+ typedef ... view_t;
+ typedef std::ptrdiff_t x_coord_t;
+ typedef std::ptrdiff_t y_coord_t;
+ typedef point2<std::ptrdiff_t> point_t;
+
+ any_image();
+ template <typename T> explicit any_image(const T& obj);
+ template <typename T> explicit any_image(T& obj, bool do_swap);
+ any_image(const any_image& v);
+
+ template <typename T> any_image& operator=(const T& obj);
+ any_image& operator=(const any_image& v);
+
+ void recreate(const point_t& dims, unsigned alignment=1);
+ void recreate(x_coord_t width, y_coord_t height, unsigned alignment=1);
+
+ std::size_t num_channels() const;
+ point_t dimensions() const;
+ x_coord_t width() const;
+ y_coord_t height() const;
+};
+\endcode
+
+Operations are invoked on variants via \p apply_operation passing a function object to perform the operation. The code for every allowed type in the
+variant is instantiated and the appropriate instantiation is selected via a switch statement. Since image view algorithms typically have time complexity
+at least linear on the number of pixels, the single switch statement of image view variant adds practically no measurable performance overhead compared
+to templated image views.
+
+Variants behave like the underlying type. Their copy constructor will invoke the copy constructor of the underlying instance. Equality operator will
+check if the two instances are of the same type and then invoke their operator==, etc. The default constructor of a variant will default-construct the
+first type. That means that \p any_image_view has shallow default-constructor, copy-constructor, assigment and equaty comparison, whereas \p any_image
+has deep ones.
+
+It is important to note that even though \p any_image_view and \p any_image resemble the static \p image_view and \p image, they do not model the full
+requirements of \p ImageViewConcept and \p ImageConcept. In particular they don't provide access to the pixels. There is no "any_pixel" or
+"any_pixel_iterator" in GIL. Such constructs could be provided via the \p variant mechanism, but doing so would result in inefficient algorithms, since
+the type resolution would have to be performed per pixel. Image-level algorithms should be implemented via \p apply_operation. That said,
+many common operations are shared between the static and dynamic types. In addition, all of the image view transformations and many STL-like image view
+algorithms have overloads operating on \p any_image_view, as illustrated with \p copy_pixels:
+
+\code
+rgb8_view_t v1(...); // concrete image view
+bgr8_view_t v2(...); // concrete image view compatible with v1 and of the same size
+any_image_view<Types> av(...); // run-time specified image view
+
+// Copies the pixels from v1 into v2.
+// If the pixels are incompatible triggers compile error
+copy_pixels(v1,v2);
+
+// The source or destination (or both) may be run-time instantiated.
+// If they happen to be incompatible, throws std::bad_cast
+copy_pixels(v1, av);
+copy_pixels(av, v2);
+copy_pixels(av, av);
+\endcode
+
+By having algorithm overloads supporting dynamic constructs, we create a base upon which it is possible to write algorithms that can work with
+either compile-time or runtime images or views. The following code, for example, uses the GIL I/O extension to turn an image on disk upside down:
+
+\code
+#include <boost\gil\extension\io\jpeg_dynamic_io.hpp>
+
+template <typename Image> // Could be rgb8_image_t or any_image<...>
+void save_180rot(const std::string& file_name) {
+ Image img;
+ jpeg_read_image(file_name, img);
+ jpeg_write_view(file_name, rotated180_view(view(img)));
+}
+\endcode
+
+It can be instantiated with either a compile-time or a runtime image because all functions it uses have overloads taking runtime constructs.
+For example, here is how \p rotated180_view is implemented:
+
+\code
+// implementation using templated view
+template <typename View>
+typename dynamic_xy_step_type<View>::type rotated180_view(const View& src) { ... }
+
+namespace detail {
+ // the function, wrapped inside a function object
+ template <typename Result> struct rotated180_view_fn {
+ typedef Result result_type;
+ template <typename View> result_type operator()(const View& src) const {
+ return result_type(rotated180_view(src));
+ }
+ };
+}
+
+// overloading of the function using variant. Takes and returns run-time bound view.
+// The returned view has a dynamic step
+template <typename ViewTypes> inline // Models MPL Random Access Container of models of ImageViewConcept
+typename dynamic_xy_step_type<any_image_view<ViewTypes> >::type rotated180_view(const any_image_view<ViewTypes>& src) {
+ return apply_operation(src,detail::rotated180_view_fn<typename dynamic_xy_step_type<any_image_view<ViewTypes> >::type>());
+}
+\endcode
+
+Variants should be used with caution (especially algorithms that take more than one variant) because they instantiate the algorithm
+for every possible model that the variant can take. This can take a toll on compile time and executable size.
+Despite these limitations, \p variant is a powerful technique that allows us to combine the speed of compile-time resolution with
+the flexibility of run-time resolution. It allows us to treat images of different parameters uniformly as a collection and store
+them in the same container.
+
+
+<hr>
+\section MetafunctionsDG 12. Useful Metafunctions and Typedefs
+
+Flexibility comes at a price. GIL types can be very long and hard to read.
+To address this problem, GIL provides typedefs to refer to any standard image, pixel iterator, pixel locator, pixel reference or pixel value.
+They follow this pattern:
+
+\e ColorSpace + \e BitDepth + ["s|f"] + ["c"] + ["_planar"] + ["_step"] + \e ClassType + "_t"
+
+Where \e ColorSpace also indicates the ordering of components. Examples are \p rgb, \p bgr, \p cmyk, \p rgba. \e BitDepth can be, for example,
+ \p 8,\p 16,\p 32. By default the bits are unsigned integral type. Append \p s to the bit depth to indicate signed integral, or \p f to indicate
+ floating point. \p c indicates object whose associated pixel reference is immutable. \p _planar indicates planar organization (as opposed to interleaved).
+\p _step indicates the type has a dynamic step and \e ClassType is \p _image (image, using a standard allocator), \p _view (image view), \p _loc
+(pixel locator), \p _ptr (pixel iterator), \p _ref (pixel reference), \p _pixel (pixel value). Here are examples:
+
+\code
+bgr8_image_t i; // 8-bit unsigned (unsigned char) interleaved BGR image
+cmyk16_pixel_t; x; // 16-bit unsigned (unsigned short) CMYK pixel value;
+cmyk16sc_planar_ref_t p(x); // const reference to a 16-bit signed integral (signed short) planar CMYK pixel x.
+rgb32f_planar_step_ptr_t ii; // step iterator to a floating point 32-bit (float) planar RGB pixel.
+\endcode
+
+GIL provides the metafunctions that return the types of standard homogeneous memory-based GIL constructs given a channel type, a layout, and whether
+the construct is planar, has a step along the X direction, and is mutable:
+
+\code
+template <typename ChannelValue, typename Layout, bool IsPlanar=false, bool IsMutable=true>
+struct pixel_reference_type { typedef ... type; };
+
+template <typename Channel, typename Layout>
+struct pixel_value_type { typedef ... type; };
+
+template <typename ChannelValue, typename Layout, bool IsPlanar=false, bool IsStep=false, bool IsMutable=true>
+struct iterator_type { typedef ... type; };
+
+template <typename ChannelValue, typename Layout, bool IsPlanar=false, bool IsXStep=false, bool IsMutable=true>
+struct locator_type { typedef ... type; };
+
+template <typename ChannelValue, typename Layout, bool IsPlanar=false, bool IsXStep=false, bool IsMutable=true>
+struct view_type { typedef ... type; };
+
+template <typename ChannelValue, typename Layout, bool IsPlanar=false, typename Alloc=std::allocator<unsigned char> >
+struct image_type { typedef ... type; };
+
+template <typename BitField, typename ChannelBitSizeVector, typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct packed_image_type { typedef ... type; };
+
+template <typename ChannelBitSizeVector, typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct bit_aligned_image_type { typedef ... type; };
+\endcode
+
+There are also helper metafunctions to construct packed and bit-aligned images with up to five channels:
+
+\code
+template <typename BitField, unsigned Size1,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct packed_image1_type { typedef ... type; };
+
+template <typename BitField, unsigned Size1, unsigned Size2,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct packed_image2_type { typedef ... type; };
+
+template <typename BitField, unsigned Size1, unsigned Size2, unsigned Size3,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct packed_image3_type { typedef ... type; };
+
+template <typename BitField, unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct packed_image4_type { typedef ... type; };
+
+template <typename BitField, unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4, unsigned Size5,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct packed_image5_type { typedef ... type; };
+
+template <unsigned Size1,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct bit_aligned_image1_type { typedef ... type; };
+
+template <unsigned Size1, unsigned Size2,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct bit_aligned_image2_type { typedef ... type; };
+
+template <unsigned Size1, unsigned Size2, unsigned Size3,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct bit_aligned_image3_type { typedef ... type; };
+
+template <unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct bit_aligned_image4_type { typedef ... type; };
+
+template <unsigned Size1, unsigned Size2, unsigned Size3, unsigned Size4, unsigned Size5,
+ typename Layout, typename Alloc=std::allocator<unsigned char> >
+struct bit_aligned_image5_type { typedef ... type; };
+
+\endcode
+
+Here \p ChannelValue models \p ChannelValueConcept. We don't need \p IsYStep because GIL's memory-based locator and
+view already allow the vertical step to be specified dynamically. Iterators and views can be constructed from a pixel type:
+
+\code
+template <typename Pixel, bool IsPlanar=false, bool IsStep=false, bool IsMutable=true>
+struct iterator_type_from_pixel { typedef ... type; };
+
+template <typename Pixel, bool IsPlanar=false, bool IsStepX=false, bool IsMutable=true>
+struct view_type_from_pixel { typedef ... type; };
+\endcode
+
+Using a heterogeneous pixel type will result in heterogeneous iterators and views. Types can also be constructed from horizontal iterator:
+
+\code
+template <typename XIterator>
+struct type_from_x_iterator {
+ typedef ... step_iterator_t;
+ typedef ... xy_locator_t;
+ typedef ... view_t;
+};
+\endcode
+
+There are metafunctions to construct the type of a construct from an existing type by changing one or more of its properties:
+
+\code
+template <typename PixelReference,
+ typename ChannelValue, typename Layout, typename IsPlanar, typename IsMutable>
+struct derived_pixel_reference_type {
+ typedef ... type; // Models PixelConcept
+};
+
+template <typename Iterator,
+ typename ChannelValue, typename Layout, typename IsPlanar, typename IsStep, typename IsMutable>
+struct derived_iterator_type {
+ typedef ... type; // Models PixelIteratorConcept
+};
+
+template <typename View,
+ typename ChannelValue, typename Layout, typename IsPlanar, typename IsXStep, typename IsMutable>
+struct derived_view_type {
+ typedef ... type; // Models ImageViewConcept
+};
+
+template <typename Image,
+ typename ChannelValue, typename Layout, typename IsPlanar>
+struct derived_image_type {
+ typedef ... type; // Models ImageConcept
+};
+\endcode
+
+You can replace one or more of its properties and use \p boost::use_default for the rest. In this case \p IsPlanar, \p IsStep and \p IsMutable
+are MPL boolean constants. For example, here is how to create the type of a view just like \p View, but being grayscale and planar:
+
+\code
+typedef typename derived_view_type<View, boost::use_default, gray_t, mpl::true_>::type VT;
+\endcode
+
+You can get pixel-related types of any pixel-based GIL constructs (pixels, iterators, locators and views) using the following
+metafunctions provided by PixelBasedConcept, HomogeneousPixelBasedConcept and metafunctions built on top of them:
+
+\code
+template <typename T> struct color_space_type { typedef ... type; };
+template <typename T> struct channel_mapping_type { typedef ... type; };
+template <typename T> struct is_planar { typedef ... type; };
+
+// Defined by homogeneous constructs
+template <typename T> struct channel_type { typedef ... type; };
+template <typename T> struct num_channels { typedef ... type; };
+\endcode
+
+These are metafunctions, some of which return integral types which can be evaluated like this:
+
+\code
+BOOST_STATIC_ASSERT(is_planar<rgb8_planar_view_t>::value == true);
+\endcode
+
+\endcode
+
+GIL also supports type analysis metafunctions of the form:
+[pixel_reference/iterator/locator/view/image] + \p "_is_" + [basic/mutable/step]. For example:
+
+\code
+if (view_is_mutable<View>::value) {
+ ...
+}
+\endcode
+
+A basic GIL construct is a memory-based construct that uses the built-in GIL classes and does not have any function object to invoke upon dereferencing.
+For example, a simple planar or interleaved, step or non-step RGB image view is basic, but a color converted view or a virtual view is not.
+
+<hr>
+\section IO_DG 13. I/O Extension
+
+GIL's I/O extension provides low level image i/o utilities. It supports loading and saving several image formats, each of which requires linking
+against the corresponding library:
+
+- JPEG: To use JPEG files, include the file <tt>gil/extension/io/jpeg_io.hpp</tt>. If you are using run-time images,
+you need to include <tt>gil/extension/io/jpeg_dynamic_io.hpp</tt> instead. You need to compile and link against libjpeg.lib
+(available at http://www.ijg.org). You need to have <tt>jpeglib.h</tt> in your include path.
+
+- TIFF: To use TIFF files, include the file <tt>gil/extension/io/tiff_io.hpp</tt>. If you are using run-time images,
+you need to include <tt>gil/extension/io/tiff_dynamic_io.hpp</tt> instead. You need to compile and link against libtiff.lib
+(available at http://www.libtiff.org). You need to have <tt>tiffio.h</tt> in your include path.
+
+- PNG: To use PNG files, include the file <tt>gil/extension/io/png_io.hpp</tt>. If you are using run-time images,
+you need to include <tt>gil/extension/io/png_dynamic_io.hpp</tt> instead. You need to compile and link against libpng.lib
+(available at http://wwwlibpng.org). You need to have <tt>png.h</tt> in your include path.
+
+You don't need to install all these libraries; just the ones you will use.
+Here are the I/O APIs for JPEG files (replace \p "jpeg" with \p "tiff" or \p "png" for the APIs of the other libraries):
+
+\code
+// Returns the width and height of the JPEG file at the specified location.
+// Throws std::ios_base::failure if the location does not correspond to a valid JPEG file
+point2<std::ptrdiff_t> jpeg_read_dimensions(const char*);
+
+// Allocates a new image whose dimensions are determined by the given jpeg image file, and loads the pixels into it.
+// Triggers a compile assert if the image color space or channel depth are not supported by the JPEG library or by the I/O extension.
+// Throws std::ios_base::failure if the file is not a valid JPEG file, or if its color space or channel depth are not
+// compatible with the ones specified by Image
+template <typename Img> void jpeg_read_image(const char*, Img&);
+
+// Allocates a new image whose dimensions are determined by the given jpeg image file, and loads the pixels into it,
+// color-converting and channel-converting if necessary.
+// Triggers a compile assert if the image color space or channel depth are not supported by the JPEG library or by the I/O extension.
+// Throws std::ios_base::failure if the file is not a valid JPEG file or if it fails to read it.
+template <typename Img> void jpeg_read_and_convert_image(const char*, Img&);
+template <typename Img, typename CCV> void jpeg_read_and_convert_image(const char*, Img&, CCV color_converter);
+
+// Loads the image specified by the given jpeg image file name into the given view.
+// Triggers a compile assert if the view color space and channel depth are not supported by the JPEG library or by the I/O extension.
+// Throws std::ios_base::failure if the file is not a valid JPEG file, or if its color space or channel depth are not
+// compatible with the ones specified by View, or if its dimensions don't match the ones of the view.
+template <typename View> void jpeg_read_view(const char*, const View&);
+
+// Loads the image specified by the given jpeg image file name into the given view and color-converts (and channel-converts) it if necessary.
+// Triggers a compile assert if the view color space and channel depth are not supported by the JPEG library or by the I/O extension.
+// Throws std::ios_base::failure if the file is not a valid JPEG file, or if its dimensions don't match the ones of the view.
+template <typename View> void jpeg_read_and_convert_view(const char*, const View&);
+template <typename View, typename CCV> void jpeg_read_and_convert_view(const char*, const View&, CCV color_converter);
+
+// Saves the view to a jpeg file specified by the given jpeg image file name.
+// Triggers a compile assert if the view color space and channel depth are not supported by the JPEG library or by the I/O extension.
+// Throws std::ios_base::failure if it fails to create the file.
+template <typename View> void jpeg_write_view(const char*, const View&);
+
+// Determines whether the given view type is supported for reading
+template <typename View> struct jpeg_read_support {
+ static const bool value = ...;
+};
+
+// Determines whether the given view type is supported for writing
+template <typename View> struct jpeg_write_support {
+ static const bool value = ...;
+};
+\endcode
+
+If you use the dynamic image extension, make sure to include \p "jpeg_dynamic_io.hpp" instead of \p "jpeg_io.hpp".
+In addition to the above methods, you have the following overloads dealing with dynamic images:
+
+\code
+// Opens the given JPEG file name, selects the first type in Images whose color space and channel are compatible to those of the image file
+// and creates a new image of that type with the dimensions specified by the image file.
+// Throws std::ios_base::failure if none of the types in Images are compatible with the type on disk.
+template <typename Images> void jpeg_read_image(const char*, any_image<Images>&);
+
+// Saves the currently instantiated view to a jpeg file specified by the given jpeg image file name.
+// Throws std::ios_base::failure if the currently instantiated view type is not supported for writing by the I/O extension
+// or if it fails to create the file.
+template <typename Views> void jpeg_write_view(const char*, any_image_view<Views>&);
+\endcode
+
+All of the above methods have overloads taking \p std::string instead of <tt>const char*</tt>
+
+<hr>
+\section SampleImgCodeDG 14. Sample Code
+
+\subsection PixelLevelExampleDG Pixel-level Sample Code
+
+Here are some operations you can do with pixel values, pointers and references:
+
+\code
+rgb8_pixel_t p1(255,0,0); // make a red RGB pixel
+bgr8_pixel_t p2 = p1; // RGB and BGR are compatible and the channels will be properly mapped.
+assert(p1==p2); // p2 will also be red.
+assert(p2[0]!=p1[0]); // operator[] gives physical channel order (as laid down in memory)
+assert(semantic_at_c<0>(p1)==semantic_at_c<0>(p2)); // this is how to compare the two red channels
+get_color(p1,green_t()) = get_color(p2,blue_t()); // channels can also be accessed by name
+
+const unsigned char* r;
+const unsigned char* g;
+const unsigned char* b;
+rgb8c_planar_ptr_t ptr(r,g,b); // constructing const planar pointer from const pointers to each plane
+
+rgb8c_planar_ref_t ref=*ptr; // just like built-in reference, dereferencing a planar pointer returns a planar reference
+
+p2=ref; p2=p1; p2=ptr[7]; p2=rgb8_pixel_t(1,2,3); // planar/interleaved references and values to RGB/BGR can be freely mixed
+
+//rgb8_planar_ref_t ref2; // compile error: References have no default constructors
+//ref2=*ptr; // compile error: Cannot construct non-const reference by dereferencing const pointer
+//ptr[3]=p1; // compile error: Cannot set the fourth pixel through a const pointer
+//p1 = pixel<float, rgb_layout_t>();// compile error: Incompatible channel depth
+//p1 = pixel<bits8, rgb_layout_t>();// compile error: Incompatible color space (even though it has the same number of channels)
+//p1 = pixel<bits8,rgba_layout_t>();// compile error: Incompatible color space (even though it contains red, green and blue channels)
+\endcode
+
+Here is how to use pixels in generic code:
+
+\code
+template <typename GrayPixel, typename RGBPixel>
+void gray_to_rgb(const GrayPixel& src, RGBPixel& dst) {
+ gil_function_requires<PixelConcept<GrayPixel> >();
+ gil_function_requires<MutableHomogeneousPixelConcept<RGBPixel> >();
+
+ typedef typename color_space_type<GrayPixel>::type gray_cs_t;
+ BOOST_STATIC_ASSERT((boost::is_same<gray_cs_t,gray_t>::value));
+
+ typedef typename color_space_type<RGBPixel>::type rgb_cs_t;
+ BOOST_STATIC_ASSERT((boost::is_same<rgb_cs_t,rgb_t>::value));
+
+ typedef typename channel_type<GrayPixel>::type gray_channel_t;
+ typedef typename channel_type<RGBPixel>::type rgb_channel_t;
+
+ gray_channel_t gray = get_color(src,gray_color_t());
+ static_fill(dst, channel_convert<rgb_channel_t>(gray));
+}
+
+// example use patterns:
+
+// converting gray l-value to RGB and storing at (5,5) in a 16-bit BGR interleaved image:
+bgr16_view_t b16(...);
+gray_to_rgb(gray8_pixel_t(33), b16(5,5));
+
+// storing the first pixel of an 8-bit grayscale image as the 5-th pixel of 32-bit planar RGB image:
+rgb32f_planar_view_t rpv32;
+gray8_view_t gv8(...);
+gray_to_rgb(*gv8.begin(), rpv32[5]);
+\endcode
+
+As the example shows, both the source and the destination can be references or values, planar or interleaved, as long as they model \p PixelConcept
+and \p MutablePixelConcept respectively.
+
+
+\subsection SafeAreaExampleDG Creating a Copy of an Image with a Safe Buffer
+
+Suppose we want to convolve an image with multiple kernels, the largest of which is 2K+1 x 2K+1 pixels. It may be worth
+creating a margin of K pixels around the image borders. Here is how to do it:
+
+\code
+template <typename SrcView, // Models ImageViewConcept (the source view)
+ typename DstImage> // Models ImageConcept (the returned image)
+void create_with_margin(const SrcView& src, int k, DstImage& result) {
+ gil_function_requires<ImageViewConcept<SrcView> >();
+ gil_function_requires<ImageConcept<DstImage> >();
+ gil_function_requires<ViewsCompatibleConcept<SrcView, typename DstImage::view_t> >();
+
+ result=DstImage(src.width()+2*k, src.height()+2*k);
+ typename DstImage::view_t centerImg=subimage_view(view(result), k,k,src.width(),src.height());
+ std::copy(src.begin(), src.end(), centerImg.begin());
+}
+\endcode
+
+We allocated a larger image, then we used \p subimage_view to create a shallow image of
+its center area of top left corner at (k,k) and of identical size as \p src, and finally we copied \p src into that center image. If the margin
+needs initialization, we could have done it with \p fill_pixels. Here is how to simplify this code using
+the \p copy_pixels algorithm:
+
+\code
+template <typename SrcView, typename DstImage>
+void create_with_margin(const SrcView& src, int k, DstImage& result) {
+ result.recreate(src.width()+2*k, src.height()+2*k);
+ copy_pixels(src, subimage_view(view(result), k,k,src.width(),src.height()));
+}
+\endcode
+
+(Note also that \p image::recreate is more efficient than \p operator=, as the latter will do an unnecessary copy construction).
+Not only does the above example work for planar and interleaved images of any color space and pixel depth; it is also optimized.
+GIL overrides \p std::copy - when called on two identical interleaved images with no padding at the end of rows, it
+simply does a \p memmove. For planar images it does \p memmove for each channel. If one of the images has padding, (as in
+our case) it will try to do \p memmove for each row. When an image has no padding, it will use its lightweight
+horizontal iterator (as opposed to the more complex 1D image iterator that has to check for the end of rows).
+It choses the fastest method, taking into account both static and run-time parameters.
+
+\subsection HistogramExampleDG Histogram
+
+The histogram can be computed by counting the number of pixel values that fall in each bin.
+The following method takes a grayscale (one-dimensional) image view, since only grayscale pixels
+are convertible to integers:
+\code
+template <typename GrayView, typename R>
+void grayimage_histogram(const GrayView& img, R& hist) {
+ for (typename GrayView::iterator it=img.begin(); it!=img.end(); ++it)
+ ++hist[*it];
+}
+\endcode
+
+Using \p boost::lambda and GIL's \p for_each_pixel algorithm, we can write this more compactly:
+
+\code
+template <typename GrayView, typename R>
+void grayimage_histogram(const GrayView& v, R& hist) {
+ for_each_pixel(v, ++var(hist)[_1]);
+}
+\endcode
+
+Where \p for_each_pixel invokes \p std::for_each and \p var and \p _1 are \p boost::lambda constructs.
+To compute the luminosity histogram, we call the above method using the grayscale view of an image:
+
+\code
+template <typename View, typename R>
+void luminosity_histogram(const View& v, R& hist) {
+ grayimage_histogram(color_converted_view<gray8_pixel_t>(v),hist);
+}
+\endcode
+
+This is how to invoke it:
+
+\code
+unsigned char hist[256];
+std::fill(hist,hist+256,0);
+luminosity_histogram(my_view,hist);
+\endcode
+
+If we want to view the histogram of the second channel of the image in the top left 100x100 area, we call:
+
+\code
+grayimage_histogram(nth_channel_view(subimage_view(img,0,0,100,100),1),hist);
+\endcode
+
+No pixels are copied and no extra memory is allocated - the code operates directly on the source pixels, which could
+be in any supported color space and channel depth. They could be either planar or interleaved.
+
+\subsection ImageViewsExampleDG Using Image Views
+
+The following code illustrates the power of using image views:
+
+\code
+jpeg_read_image("monkey.jpg", img);
+step1=view(img);
+step2=subimage_view(step1, 200,300, 150,150);
+step3=color_converted_view<rgb8_view_t,gray8_pixel_t>(step2);
+step4=rotated180_view(step3);
+step5=subsampled_view(step4, 2,1);
+jpeg_write_view("monkey_transform.jpg", step5);
+\endcode
+
+The intermediate images are shown here:
+\image html monkey_steps.jpg
+
+Notice that no pixels are ever copied. All the work is done inside \p jpeg_write_view.
+If we call our \p luminosity_histogram with \p step5 it will do the right thing.
+
+
+<hr>
+\section ExtendingGIL_DG 15. Extending the Generic Image Library
+
+You can define your own pixel iterators, locators, image views, images, channel types, color spaces and algorithms.
+You can make virtual images that live on the disk, inside a jpeg file, somewhere on the internet, or even fully-synthetic images
+such as the Mandelbrot set.
+As long as they properly model the corresponding concepts, they will work with any existing GIL code.
+Most such extensions require no changes to the library and can thus be
+supplied in another module.
+
+\subsection NewColorSpacesDG Defining New Color Spaces
+
+Each color space is in a separate file. To add a new color space, just copy one of the existing ones (like rgb.hpp) and change it
+accordingly. If you want color conversion support, you will have to provide methods to convert between it and the existing color spaces
+(see color_convert.h). For convenience you may want to provide useful typedefs for pixels, pointers, references and images with the new
+color space (see typedefs.h).
+
+\subsection NewChannelsDG Defining New Channel Types
+
+Most of the time you don't need to do anything special to use a new channel type. You can just use it:
+
+\code
+typedef pixel<double,rgb_layout_t> rgb64_pixel_t; // 64 bit RGB pixel
+typedef rgb64_pixel* rgb64_pixel_ptr_t;// pointer to 64-bit interleaved data
+typedef image_type<double,rgb_layout_t>::type rgb64_image_t; // 64-bit interleaved image
+\endcode
+
+If you want to use your own channel class, you will need to provide a specialization of \p channel_traits for it (see channel.hpp).
+If you want to do conversion between your and existing channel types, you will need to provide an overload of \p channel_convert.
+
+\subsection NewColorConversionDG Overloading Color Conversion
+
+Suppose you want to provide your own color conversion. For example, you may want to implement higher quality color conversion using color profiles.
+Typically you may want to redefine color conversion only in some instances and default to GIL's color conversion in all other cases. Here is, for
+example, how to overload color conversion so that color conversion to gray inverts the result but everything else remains the same:
+
+\code
+// make the default use GIL's default
+template <typename SrcColorSpace, typename DstColorSpace>
+struct my_color_converter_impl
+ : public default_color_converter_impl<SrcColorSpace,DstColorSpace> {};
+
+// provide specializations only for cases you care about
+// (in this case, if the destination is grayscale, invert it)
+template <typename SrcColorSpace>
+struct my_color_converter_impl<SrcColorSpace,gray_t> {
+ template <typename SrcP, typename DstP> // Model PixelConcept
+ void operator()(const SrcP& src, DstP& dst) const {
+ default_color_converter_impl<SrcColorSpace,gray_t>()(src,dst);
+ get_color(dst,gray_color_t())=channel_invert(get_color(dst,gray_color_t()));
+ }
+};
+
+// create a color converter object that dispatches to your own implementation
+struct my_color_converter {
+ template <typename SrcP, typename DstP> // Model PixelConcept
+ void operator()(const SrcP& src,DstP& dst) const {
+ typedef typename color_space_type<SrcP>::type SrcColorSpace;
+ typedef typename color_space_type<DstP>::type DstColorSpace;
+ my_color_converter_impl<SrcColorSpace,DstColorSpace>()(src,dst);
+ }
+};
+\endcode
+
+GIL's color conversion functions take the color converter as an optional parameter. You can pass your own color converter:
+
+\code
+color_converted_view<gray8_pixel_t>(img_view,my_color_converter());
+\endcode
+
+\subsection NewImagesDG Defining New Image Views
+
+ You can provide your own pixel iterators, locators and views, overriding either the mechanism for getting from one pixel to the next or doing an arbitrary
+pixel transformation on dereference. For example, let's look at the implementation of \p color_converted_view (an image factory method that,
+given any image view, returns a new, otherwise identical view, except that color conversion is performed on pixel access).
+First we need to define a model of \p PixelDereferenceAdaptorConcept; a function object that will be called when we dereference a pixel iterator.
+It will call \p color_convert to convert to the destination pixel type:
+
+\code
+template <typename SrcConstRefP, // const reference to the source pixel
+ typename DstP> // Destination pixel value (models PixelValueConcept)
+class color_convert_deref_fn {
+public:
+ typedef color_convert_deref_fn const_t;
+ typedef DstP value_type;
+ typedef value_type reference; // read-only dereferencing
+ typedef const value_type& const_reference;
+ typedef SrcConstRefP argument_type;
+ typedef reference result_type;
+ BOOST_STATIC_CONSTANT(bool, is_mutable=false);
+
+ result_type operator()(argument_type srcP) const {
+ result_type dstP;
+ color_convert(srcP,dstP);
+ return dstP;
+ }
+};
+
+\endcode
+
+We then use the \p add_deref member struct of image views to construct the type of a view that invokes a given function object (\p deref_t) upon
+dereferencing. In our case, it performs color conversion:
+
+\code
+template <typename SrcView, typename DstP>
+struct color_converted_view_type {
+private:
+ typedef typename SrcView::const_t::reference src_pix_ref; // const reference to pixel in SrcView
+ typedef color_convert_deref_fn<src_pix_ref, DstP> deref_t; // the dereference adaptor that performs color conversion
+ typedef typename SrcView::template add_deref<deref_t> add_ref_t;
+public:
+ typedef typename add_ref_t::type type; // the color converted view type
+ static type make(const SrcView& sv) { return add_ref_t::make(sv, deref_t()); }
+};
+\endcode
+
+Finally our \p color_converted_view code simply creates color-converted view from the source view:
+
+\code
+template <typename DstP, typename View> inline
+typename color_converted_view_type<View,DstP>::type color_convert_view(const View& src) {
+ return color_converted_view_type<View,DstP>::make(src);
+}
+\endcode
+
+(The actual color convert view transformation is slightly more complicated, as it takes an optional color conversion object, which
+allows users to specify their own color conversion methods).
+See the GIL tutorial for an example of creating a virtual image view that defines the Mandelbrot set.
+
+<hr>
+\section TechnicalitiesDG 16. Technicalities
+
+\subsection CreatingReferenceProxyDG Creating a reference proxy
+
+Sometimes it is necessary to create a proxy class that represents a reference to a given object. Examples of these are GIL's reference
+to a planar pixel (\p planar_pixel_reference) and GIL's subbyte channel references. Writing a reference proxy class can be tricky. One
+problem is that the proxy reference is constructed as a temporary object and returned by value upon dereferencing the iterator:
+
+\code
+struct rgb_planar_pixel_iterator {
+ typedef my_reference_proxy<T> reference;
+ reference operator*() const { return reference(red,green,blue); }
+};
+\endcode
+
+The problem arises when an iterator is dereferenced directly into a function that takes a mutable pixel:
+
+\code
+template <typename Pixel> // Models MutablePixelConcept
+void invert_pixel(Pixel& p);
+
+rgb_planar_pixel_iterator myIt;
+invert_pixel(*myIt); // compile error!
+\endcode
+
+C++ does not allow for matching a temporary object against a non-constant reference. The solution is to:
+- Use const qualifier on all members of the reference proxy object:
+
+\code
+template <typename T>
+struct my_reference_proxy {
+ const my_reference_proxy& operator=(const my_reference_proxy& p) const;
+ const my_reference_proxy* operator->() const { return this; }
+ ...
+};
+\endcode
+
+- Use different classes to denote mutable and constant reference (maybe based on the constness of the template parameter)
+
+- Define the reference type of your iterator with const qualifier:
+
+\code
+struct iterator_traits<rgb_planar_pixel_iterator> {
+ typedef const my_reference_proxy<T> reference;
+};
+\endcode
+
+A second important issue is providing an overload for \p swap for your reference class. The default \p std::swap will not
+work correctly. You must use a real value type as the temporary.
+A further complication is that in some implementations of the STL the \p swap function is incorreclty called qualified, as \p std::swap.
+The only way for these STL algorithms to use your overload is if you define it in the \p std namespace:
+\code
+namespace std {
+ template <typename T>
+ void swap(my_reference_proxy<T>& x, my_reference_proxy<T>& y) {
+ my_value<T> tmp=x;
+ x=y;
+ y=tmp;
+ }
+}
+\endcode
+
+Lastly, remember that constructors and copy-constructors of proxy references are always shallow and assignment operators are deep.
+
+We are grateful to Dave Abrahams, Sean Parent and Alex Stepanov for suggesting the above solution.
+
+<hr>
+\section ConclusionDG 17. Conclusion
+
+The Generic Image Library is designed with the following five goals in mind:
+
+\li Generality. Abstracts image representations from algorithms on images. It allows for writing code once and have it work for any image type.
+\li Performance. Speed has been instrumental to the design of the library. The generic algorithms provided in the library are in many cases comparable in
+ speed to hand-coding the algorithm for a specific image type.
+\li Flexibility. Compile-type parameter resolution results in faster code, but severely limits code flexibility. The library allows for any
+ image parameter to be specified at run time, at a minor performance cost.
+\li Extensibility. Virtually every construct in GIL can be extended - new channel types, color spaces, layouts, iterators, locators, image views and images
+ can be provided by modeling the corresponding GIL concepts.
+\li Compatibility. The library is designed as an STL complement. Generic STL algorithms can be used for pixel manipulation, and they
+ are specifically targeted for optimization. The library works with existing raw pixel data from another image library.
+
+<div id="footerrow"></div><div id="footer" title="footer: links to copyright and other legal information">Copyright © 2005 Adobe Systems Incorporated<ul id="list1"><li id="terms"><a title="Terms of Use" href="http://www.adobe.com/misc/copyright.html">Terms of Use</a></li><li><a title="Privacy Policy" href="http://www.adobe.com/misc/privacy.html">Privacy Policy</a></li><li>Accessibility</li><li><a title="Avoid software piracy" href="http://www.adobe.com/aboutadobe/antipiracy/main.html">Avoid software piracy</a></li><li id="tms"><a title="Permissions and trademarks" href="http://www.adobe.com/misc/agreement.html">Permissions and trademarks</a></li><li><a title="Product License Agreements" href="http://www.adobe.com/products/eulas/main.html">Product License Agreements</a></li></ul></div>
+
+*/
+

Added: trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
@@ -0,0 +1,261 @@
+# Doxyfile 1.4.4
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "Generic Image Library "
+PROJECT_NUMBER =
+OUTPUT_DIRECTORY = ../../
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = YES
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF = "The $name class " \
+ "The $name widget " \
+ "The $name file " \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = YES
+INHERIT_DOCS = YES
+DISTRIBUTE_GROUP_DOC = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 8
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+SUBGROUPING = NO
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = NO
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = NO
+EXTRACT_LOCAL_METHODS = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = YES
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = NO
+HIDE_SCOPE_NAMES = YES
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = NO
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = YES
+FILE_VERSION_FILTER =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = NO
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text "
+WARN_LOGFILE = warnings.txt
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = ./ \
+ ../ \
+ ../../../../../boost/gil \
+ ../../../../../boost/gil/extension/io \
+ ../../../../../boost/gil/extension/dynamic_image
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.d \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.idl \
+ *.odl \
+ *.cs \
+ *.php \
+ *.php3 \
+ *.inc \
+ *.m \
+ *.mm \
+ *.dox
+RECURSIVE = NO
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH = ../images
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = NO
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 3
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER = header.html
+HTML_FOOTER =
+HTML_STYLESHEET = ../../adobe_source.css
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = NO
+TOC_EXPAND = NO
+DISABLE_INDEX = YES
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED = ADOBE_GIL_STANDALONE_DOCUMENTATION
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = NO
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 1024
+MAX_DOT_GRAPH_HEIGHT = 1024
+MAX_DOT_GRAPH_DEPTH = 1000
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO

Added: trunk/libs/gil/doc/doxygen/gil_standalone/header.html
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/doxygen/gil_standalone/header.html 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
@@ -0,0 +1,33 @@
+
+
+<!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>$title</TITLE>
+ <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
+ <LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
+ <LINK REL="alternate" TITLE="stlab.adobe.com RSS" HREF="http://sourceforge.net/export/rss2_projnews.php?group_id=132417&rss_fulltext=1" TYPE="application/rss+xml"/>
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+ </script>
+</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="globals.html">File Members</a>
+ | <a class="qindex" href="../index.html">GIL Home Page</a>
+</div>
+

Added: trunk/libs/gil/doc/doxygen/gil_standalone/main.dox
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/doxygen/gil_standalone/main.dox 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
@@ -0,0 +1,278 @@
+ /// \defgroup BasicConcepts Basic Concepts
+ /// \brief Various basic concepts
+
+ /// \defgroup Point Point
+ /// \brief N-dimensional point
+ /// \defgroup PointConcept Concepts
+ /// \ingroup Point
+ /// \brief Concepts for points
+
+ /// \defgroup PointModel Models
+ /// \ingroup Point
+ /// \brief Models for points
+
+ /// \defgroup PointAlgorithm Algorithms and Utility Functions
+ /// \ingroup Point
+ /// \brief Algorithms and Utility Functions for points
+
+ /// \defgroup ColorSpaceAndLayout Color, Color Space, and Layout
+ /// \brief The color space and the layout define the set, ordering and interpretation of channels in a pixel
+ /// \defgroup ColorSpaceAndLayoutConcept Concepts
+ /// \ingroup ColorSpaceAndLayout
+
+ /// \defgroup ColorSpaceAndLayoutModel Models
+ /// \ingroup ColorSpaceAndLayout
+
+ /// \defgroup ColorNameModel Color Names
+ /// \ingroup ColorSpaceAndLayoutModel
+
+ /// \defgroup ColorSpaceModel Color Spaces
+ /// \ingroup ColorSpaceAndLayoutModel
+
+ /// \defgroup LayoutModel Layouts
+ /// \ingroup ColorSpaceAndLayoutModel
+
+ /// \defgroup Channel Channel
+ /// \brief Channel is the building block of pixel
+ /// \defgroup ChannelConcept Concepts
+ /// \ingroup Channel
+ /// \brief Concepts for channels
+
+ /// \defgroup ChannelModel Models
+ /// \ingroup Channel
+ /// \brief Channel models. Although not required by the ChannelConcept, all GIL-provided channels support arithmetic operations
+
+ /// \defgroup ChannelAlgorithm Algorithms and Utility Functions
+ /// \ingroup Channel
+ /// \brief Channel algorithms, metafunctions and utility functions
+
+/**
+ \defgroup ColorBase ColorBase
+ \brief A color base is a container of color elements.
+
+The most common use of color base is in the implementation of a pixel, in which case the color
+elements are channel values. The color base concept, however, can be used in other scenarios. For example, a planar pixel has channels that are not
+contiguous in memory. Its reference is a proxy class that uses a color base whose elements are channel references. Its iterator uses a color base
+whose elements are channel iterators.
+*/
+ /// \defgroup ColorBaseConcept Concepts
+ /// \ingroup ColorBase
+ /// \brief ColorBase concepts
+
+ /// \defgroup ColorBaseModel Models
+ /// \ingroup ColorBase
+ /// \brief ColorBase models
+
+ /// \defgroup ColorBaseAlgorithm Algorithms and Utility Functions
+ /// \ingroup ColorBase
+ /// \brief ColorBase algorithms, metafunctions and utility functions
+
+/**
+ \defgroup PixelBased PixelBased
+ \brief Concepts for all GIL constructs that are pixel-based (pixels, pixel iterators, locators, views, images).
+
+ PixelBasedConcept provides a uniform interface for getting some common properties of pixel-based constructs, such as the number of channels,
+ the color space, the layout, etc.
+*/
+ /// \defgroup PixelBasedConcept Concepts
+ /// \ingroup PixelBased
+ /// \brief PixelBased concepts
+
+ /// \defgroup PixelBasedModel Models
+ /// \ingroup PixelBased
+ /// \brief PixelBased models
+
+ /// \defgroup PixelBasedAlgorithm Algorithms and Utility Functions
+ /// \ingroup PixelBased
+ /// \brief PixelBased algorithms, metafunctions and utility functions.
+
+/**
+ \defgroup Pixel Pixel
+ \brief A pixel is a set of channels defining the color at a given point in an image.
+
+Conceptually, a pixel is little more than a color base whose elements model \p ChannelConcept.
+Many properties of pixels inherit from color bases: pixels may be homogeneous if all of their channels have the same type; otherwise they are
+called heterogeneous. The channels of a pixel may be addressed using semantic or physical indexing, or by color; all color base algorithms
+work on pixels as well. Two pixels are compatible if their color spaces are the same and their channels, paired semantically, are compatible.
+Note that constness, memory organization and reference/value are ignored. For example, an 8-bit RGB planar reference is compatible to a constant 8-bit
+BGR interleaved pixel value. Most pairwise pixel operations (copy construction, assignment, equality, etc.) are only defined for compatible pixels.
+
+*/
+ /// \defgroup PixelConcept Concepts
+ /// \ingroup Pixel
+ /// \brief Pixel concepts
+
+ /// \defgroup PixelModel Models
+ /// \ingroup Pixel
+ /// \brief Pixel models
+
+/**
+ \defgroup PixelAlgorithm Algorithms and Utility Functions
+ \ingroup Pixel
+ \brief Pixel algorithms, metafunctions and utility functions.
+
+Since pixels model the ColorBaseConcept, all color-base related algorithms also apply to pixels. See \ref ColorBaseAlgorithm for more.
+
+*/
+
+ /// \defgroup PixelDereferenceAdaptor Pixel Dereference Adaptor
+ /// \brief A function object invoked upon accessing of the pixel of a pixel iterator/locator/view
+
+ /// \defgroup PixelDereferenceAdaptorConcept Concepts
+ /// \ingroup PixelDereferenceAdaptor
+
+ /// \defgroup PixelDereferenceAdaptorModel Models
+ /// \ingroup PixelDereferenceAdaptor
+
+
+ /// \defgroup PixelIterator Pixel Iterator
+ /// \brief STL Iterators over models of PixelConcept
+
+ /// \defgroup PixelIteratorConcept Concepts
+ /// \ingroup PixelIterator
+ /// \brief Pixel iterator concepts
+
+ /// \defgroup PixelIteratorModel Models
+ /// \ingroup PixelIterator
+ /// \brief Pixel iterator models
+
+
+ /// \defgroup PixelLocator Pixel Locator
+ /// \brief Generalization of an iterator to multiple dimensions
+
+ /// \defgroup PixelLocatorConcept Concepts
+ /// \ingroup PixelLocator
+ /// \brief Pixel locator concepts
+
+ /// \defgroup PixelLocatorModel Models
+ /// \ingroup PixelLocator
+ /// \brief Pixel locator models
+
+ /// \defgroup ImageView Image View
+ /// \brief N-dimensional range
+
+ /// \defgroup ImageViewConcept Concepts
+ /// \ingroup ImageView
+ /// \brief Image view concepts
+
+ /// \defgroup ImageViewModel Models
+ /// \ingroup ImageView
+ /// \brief Image view models
+
+ /// \defgroup ImageViewAlgorithm Algorithms and Utility Functions
+ /// \ingroup ImageView
+ /// \brief Image view algorithms, metafunctions and utility functions
+
+/**
+ \defgroup Image Image
+ \brief N-dimensional container
+
+ An image is a container of N-dimensional data. GIL provides only one model, a two dimensional image whose \p value_type is a pixel.
+
+ Images are regular types (which means they have a default constructor, a copy constructor, \p operator=, \p operator==, \p operator!=, and \p swap)
+ As containers, images own the data, which means they allocate the data in their constructors and deallocate in the destructors. Their copy construction,
+ assignment and equality comparison is deep (i.e. propagates the operation to the values). That makes images expensive to pass by value, unlike views.
+
+ Also, unlike views, images propagate their constness to the data. An const-qualified image does not allow for modifying its pixels and does not provide
+ a mutable view over its pixels.
+
+ Images provide two services: they manage ownership of their data (the pixels) and they can return a view over their pixels.
+ Algorithms predominantly operate on views. This is analogous to the STL: In the STL containers (like \p std::vector) provide ranges (\p vec.begin()
+ and \p vec.end() ) and algorithms typically operate on ranges. The GIL equivalent of a range is an image view.
+
+*/
+ /// \defgroup ImageConcept Concepts
+ /// \ingroup Image
+ /// \brief Image concepts
+
+ /// \defgroup ImageModel Models
+ /// \ingroup Image
+ /// \brief Image models
+
+ /// \defgroup Variant Variant
+ /// \brief A holder of a runtime instantiated type. Used to provide runtime-specified images and views
+
+ /// \defgroup Metafunctions Metafunctions
+ /// \brief Metafunctions to construct or query GIL types
+ /// \defgroup TypeFactory Type Factory Metafunctions
+ /// \ingroup Metafunctions
+ /// \brief Metafunctions that construct GIL types from related types or from components
+
+ /// \defgroup TypeAnalysis Type Analysis Metafunctions
+ /// \ingroup Metafunctions
+ /// \brief Metafunctions that determine properties of GIL types
+
+ /// \defgroup IO I/O
+ /// \brief Support for reading and writing images to file
+ /// \defgroup JPEG_IO JPEG I/O
+ /// \ingroup IO
+ /// \brief Support for reading and writing JPEG image files
+
+ /// \defgroup TIFF_IO TIFF I/O
+ /// \ingroup IO
+ /// \brief Support for reading and writing TIFF image files
+
+ /// \defgroup PNG_IO PNG I/O
+ /// \ingroup IO
+ /// \brief Support for reading and writing PNG image files
+
+/*!
+\mainpage Generic Image Library
+
+\section Documentation
+
+- A Quick, Hands-on \ref GILTutorial "Tutorial".
+- A Detailed \ref GILDesignGuide "Design Guide".
+
+\section Modules
+
+ - \ref BasicConcepts
+ - \ref Point
+ - \ref PointConcept
+ - \ref PointModel
+ - \ref PointAlgorithm
+ - \ref ColorSpaceAndLayout
+ - \ref ColorSpaceAndLayoutConcept
+ - \ref ColorSpaceAndLayoutModel
+ - \ref Channel
+ - \ref ChannelConcept
+ - \ref ChannelModel
+ - \ref ChannelAlgorithm
+ - \ref ColorBase
+ - \ref ColorBaseConcept
+ - \ref ColorBaseModel
+ - \ref ColorBaseAlgorithm
+ - \ref PixelBased
+ - \ref PixelBasedConcept
+ - \ref PixelBasedModel
+ - \ref PixelBasedAlgorithm
+ - \ref Pixel
+ - \ref PixelConcept
+ - \ref PixelModel
+ - \ref PixelAlgorithm
+ - \ref PixelDereferenceAdaptor
+ - \ref PixelDereferenceAdaptorConcept
+ - \ref PixelDereferenceAdaptorModel
+ - \ref PixelIterator
+ - \ref PixelIteratorConcept
+ - \ref PixelIteratorModel
+ - \ref PixelLocator
+ - \ref PixelLocatorConcept
+ - \ref PixelLocatorModel
+ - \ref ImageView
+ - \ref ImageViewConcept
+ - \ref ImageViewModel
+ - \ref ImageViewAlgorithm
+ - \ref Image
+ - \ref ImageConcept
+ - \ref ImageModel
+ - \ref Metafunctions
+ - \ref TypeFactory
+ - \ref TypeAnalysis
+ - \ref Variant
+ - \ref IO
+ - \ref JPEG_IO
+ - \ref TIFF_IO
+ - \ref PNG_IO
+*/
+

Added: trunk/libs/gil/doc/doxygen/images/interleaved.jpg
==============================================================================
Binary file. No diff available.

Added: trunk/libs/gil/doc/doxygen/images/mandel.jpg
==============================================================================
Binary file. No diff available.

Added: trunk/libs/gil/doc/doxygen/images/monkey_steps.jpg
==============================================================================
Binary file. No diff available.

Added: trunk/libs/gil/doc/doxygen/images/planar.jpg
==============================================================================
Binary file. No diff available.

Added: trunk/libs/gil/doc/doxygen/images/step_iterator.gif
==============================================================================
Binary file. No diff available.

Added: trunk/libs/gil/doc/doxygen/tutorial.dox
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/doxygen/tutorial.dox 2009-05-02 08:38:39 EDT (Sat, 02 May 2009)
@@ -0,0 +1,768 @@
+////////////////////////////////////////////////////////////////////////////////////////
+/// \file
+/// \brief Doxygen documentation
+/// \author Lubomir Bourdev and Hailin Jin \n
+/// Adobe Systems Incorporated
+///
+///
+////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+\page GILTutorial Generic Image Library Tutorial
+
+\author Lubomir Bourdev (lbourdev_at_[hidden]) and Hailin Jin (hljin_at_[hidden]) \n
+ Adobe Systems Incorporated
+
+\version 2.1
+\date September 15, 2007
+
+The Generic Image Library (GIL) is a C++ library that abstracts image representations from algorithms and allows writing code that can work on
+a variety of images with performance similar to hand-writing for a specific image type.
+This document will give you a jump-start in using GIL. It does not discuss the underlying design
+of the library and does not cover all aspects of it. You can find a detailed library design document on the main GIL web page
+at http://stlab.adobe.com/gil
+
+- \ref InstallSec
+- \ref ExampleSec
+ - \ref InterfaceSec
+ - \ref FirstImplementationSec
+ - \ref LocatorsSec
+ - \ref GenericVersionSec
+ - \ref ImageViewTransformationSec
+ - \ref OneDIteratorsSec
+ - \ref STLEquivalentsSec
+ - \ref ColorConversionSec
+ - \ref ImagesSec
+ - \ref VirtualViewSec
+ - \ref DynamicImageSec
+ - \ref ConclusionSec
+- \ref AppendixSec
+ - \ref AppendixConventionSec
+
+\section InstallSec Installation
+
+The latest version of GIL can be downloaded from GIL's web page, at http://stlab.adobe.com/gil.
+GIL is approved for integration into Boost and in the future will be installed simply by installing Boost from http://www.boost.org.
+GIL consists of header files only and does not require any libraries to link against. It does not require Boost to be built.
+Including \p boost/gil/gil_all.hpp will be sufficient for most projects.
+
+\section ExampleSec Example - Computing the Image Gradient
+
+This tutorial will walk through an example of using GIL to compute the image gradients.
+We will start with some very simple and non-generic code and make it more generic as we go along.
+Let us start with a horizontal gradient and use the simplest possible approximation to a gradient - central difference.
+The gradient at pixel x can be approximated with the half-difference of its two neighboring pixels:
+D[x] = (I[x-1] - I[x+1]) / 2
+
+For simplicity, we will also ignore the boundary cases - the pixels along the edges of the image for which one of the neighbors is not defined.
+The focus of this document is how to use GIL, not how to create a good gradient generation algorithm.
+
+\subsection InterfaceSec Interface and Glue Code
+
+Let us first start with 8-bit unsigned grayscale image as the input and 8-bit signed grayscale image as the output.
+Here is how the interface to our algorithm looks like:
+
+\code
+#include <boost/gil/gil_all.hpp>
+using namespace boost::gil;
+
+void x_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ assert(src.dimensions() == dst.dimensions());
+ ... // compute the gradient
+}
+\endcode
+
+\p gray8c_view_t is the type of the source image view - an 8-bit grayscale view, whose pixels are read-only (denoted by the \p "c"). The output
+is a grayscale view with a 8-bit signed (denoted by the \p "s") integer channel type. See Appendix 1 for the complete convension GIL uses to name concrete types.
+
+GIL makes a distinction between an image and an image view. A GIL image view, is a shallow, lightweight view of a rectangular grid of pixels. It provides access to the pixels
+but does not own the pixels. Copy-constructing a view does not deep-copy the pixels. Image views do not propagate their constness to the pixels and should
+always be taken by a const reference. Whether a view is mutable or read-only (immutable) is a property of the view type.
+
+A GIL \e image, on the other hand, is a view with associated ownership. It is a container of pixels; its constructor/destructor allocates/deallocates the pixels, its copy-constructor
+performs deep-copy of the pixels and its operator== performs deep-compare of the pixels. Images also propagate their constness to their pixels - a constant reference to an image will not
+allow for modifying its pixels.
+
+Most GIL algorithms operate on image views; images are rarely needed. GIL's design is very similar to that of the STL. The STL equivalent of GIL's image is a container, like \p std::vector, whereas
+GIL's image view corresponds to STL's range, which is often represented with a pair of iterators. STL algorithms operate on ranges, just like GIL algorithms operate on image views.
+
+GIL's image views can be constructed from raw data - the dimensions, the number of bytes per row and the pixels, which for chunky views are represented with one pointer. Here is how to provide
+the glue between your code and GIL:
+
+\code
+void ComputeXGradientGray8(const unsigned char* src_pixels, ptrdiff_t src_row_bytes, int w, int h,
+ signed char* dst_pixels, ptrdiff_t dst_row_bytes) {
+ gray8c_view_t src = interleaved_view(w, h, (const gray8_pixel_t*)src_pixels,src_row_bytes);
+ gray8s_view_t dst = interleaved_view(w, h, ( gray8s_pixel_t*)dst_pixels,dst_row_bytes);
+ x_gradient(src,dst);
+}
+\endcode
+
+This glue code is very fast and views are lightweight - in the above example the views have a size of 16 bytes. They consist of a pointer to the top left pixel and three integers - the width, height,
+and number of bytes per row.
+
+\subsection FirstImplementationSec First Implementation
+
+Focusing on simplicity at the expense of speed, we can compute the horizontal gradient like this:
+
+\code
+void x_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ for (int y=0; y<src.height(); ++y)
+ for (int x=1; x<src.width()-1; ++x)
+ dst(x,y) = (src(x-1,y) - src(x+1,y)) / 2;
+}
+\endcode
+
+We use image view's \p operator(x,y) to get a reference to the pixel at a given location and we set it to the half-difference of its left and right neighbors.
+operator() returns a reference to a grayscale pixel. A grayscale pixel is convertible to its channel type (<tt>unsigned char</tt> for \p src) and it can be copy-constructed from a channel.
+(This is only true for grayscale pixels).
+While the above code is easy to read, it is not very fast, because the binary \p operator() computes the location of the pixel in a 2D grid, which involves addition and multiplication. Here is
+a faster version of the above:
+
+\code
+void x_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ for (int y=0; y<src.height(); ++y) {
+ gray8c_view_t::x_iterator src_it = src.row_begin(y);
+ gray8s_view_t::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=1; x<src.width()-1; ++x)
+ dst_it[x] = (src_it[x-1] - src_it[x+1]) / 2;
+ }
+}
+\endcode
+
+We use pixel iterators initialized at the beginning of each row. GIL's iterators are Random Access Traversal iterators. If you are not familiar with random access iterators, think of them as if they
+were pointers. In fact, in the above example the two iterator types are raw C pointers and their \p operator[] is a fast pointer indexing operator.
+
+The code to compute gradient in the vertical direction is very similar:
+
+\code
+void y_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ for (int x=0; x<src.width(); ++x) {
+ gray8c_view_t::y_iterator src_it = src.col_begin(x);
+ gray8s_view_t::y_iterator dst_it = dst.col_begin(x);
+
+ for (int y=1; y<src.height()-1; ++y)
+ dst_it[y] = (src_it[y-1] - src_it[y+1])/2;
+ }
+}
+\endcode
+
+Instead of looping over the rows, we loop over each column and create a \p y_iterator, an iterator moving vertically. In this case a simple pointer cannot be used because the distance
+between two adjacent pixels equals the number of bytes in each row of the image. GIL uses here a special step iterator class whose size is 8 bytes - it contains a raw C pointer and a step.
+Its \p operator[] multiplies the index by its step.
+
+The above version of \p y_gradient, however, is much slower (easily an order of magnitude slower) than \p x_gradient because of the memory access pattern; traversing an image vertically
+results in lots of cache misses. A much more efficient and cache-friendly version will iterate over the columns in the inner loop:
+
+\code
+void y_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ for (int y=1; y<src.height()-1; ++y) {
+ gray8c_view_t::x_iterator src1_it = src.row_begin(y-1);
+ gray8c_view_t::x_iterator src2_it = src.row_begin(y+1);
+ gray8s_view_t::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=0; x<src.width(); ++x) {
+ *dst_it = ((*src1_it) - (*src2_it))/2;
+ ++dst_it;
+ ++src1_it;
+ ++src2_it;
+ }
+ }
+}
+\endcode
+
+This sample code also shows an alternative way of using pixel iterators - instead of \p operator[] one could use increments and dereferences.
+
+
+
+
+
+\subsection LocatorsSec Using Locators
+
+Unfortunately this cache-friendly version requires the extra hassle of maintaining two separate iterators in the source view. For every pixel,
+we want to access its neighbors above and below it. Such relative access can be done with GIL locators:
+
+\code
+void y_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ gray8c_view_t::xy_locator src_loc = src.xy_at(0,1);
+ for (int y=1; y<src.height()-1; ++y) {
+ gray8s_view_t::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=0; x<src.width(); ++x) {
+ (*dst_it) = (src_loc(0,-1) - src_loc(0,1)) / 2;
+ ++dst_it;
+ ++src_loc.x(); // each dimension can be advanced separately
+ }
+ src_loc+=point2<std::ptrdiff_t>(-src.width(),1); // carriage return
+ }
+}
+\endcode
+
+The first line creates a locator pointing to the first pixel of the second row of the source view. A GIL pixel locator is very similar to an iterator,
+except that it can move both horizontally and vertically. \p src_loc.x() and \p src_loc.y() return references to a horizontal and a vertical iterator
+respectively, which can be used to move the locator along the desired dimension, as shown above. Additionally, the locator can be advanced in both dimensions
+simultaneously using its \p operator+= and \p operator-=. Similar to image views, locators provide binary \p operator() which returns a reference to a pixel
+with a relative offset to the current locator position. For example, \p src_loc(0,1) returns a reference to the neighbor below the current pixel.
+Locators are very lightweight objects - in the above example the locator has a size of 8 bytes - it consists of a raw pointer to the current pixel and an int
+indicating the number of bytes from one row to the next (which is the step when moving vertically). The call to \p ++src_loc.x() corresponds to a single C pointer increment.
+However, the example above performs more computations than necessary. The code src_loc(0,1) has to compute the offset of the pixel in two dimensions, which is slow.
+Notice though that the offset of the two neighbors is the same, regardless of the pixel location. To improve the performance, GIL can cache and reuse this offset:
+
+\code
+void y_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ gray8c_view_t::xy_locator src_loc = src.xy_at(0,1);
+ gray8c_view_t::xy_locator::cached_location_t above = src_loc.cache_location(0,-1);
+ gray8c_view_t::xy_locator::cached_location_t below = src_loc.cache_location(0, 1);
+
+ for (int y=1; y<src.height()-1; ++y) {
+ gray8s_view_t::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=0; x<src.width(); ++x) {
+ (*dst_it) = (src_loc[above] - src_loc[below])/2;
+ ++dst_it;
+ ++src_loc.x();
+ }
+ src_loc+=point2<std::ptrdiff_t>(-src.width(),1);
+ }
+}
+\endcode
+
+In this example \p "src_loc[above]" corresponds to a fast pointer indexing operation and the code is efficient.
+
+\subsection GenericVersionSec Creating a Generic Version of GIL Algorithms
+
+Let us make our \p x_gradient more generic. It should work with any image views, as long as they have the same number of channels.
+The gradient operation is to be computed for each channel independently. Here is how the new interface looks like:
+
+\code
+template <typename SrcView, typename DstView>
+void x_gradient(const SrcView& src, const DstView& dst) {
+ gil_function_requires<ImageViewConcept<SrcView> >();
+ gil_function_requires<MutableImageViewConcept<DstView> >();
+ gil_function_requires<ColorSpacesCompatibleConcept<
+ typename color_space_type<SrcView>::type,
+ typename color_space_type<DstView>::type> >();
+
+ ... // compute the gradient
+}
+\endcode
+
+The new algorithm now takes the types of the input and output image views as template parameters.
+That allows using both built-in GIL image views, as well as any user-defined image view classes.
+The first three lines are optional; they use \p boost::concept_check to ensure that the two arguments
+are valid GIL image views, that the second one is mutable and that their color spaces are compatible (i.e. have the same set of channels).
+
+GIL does not require using its own built-in constructs. You are free to use your own channels, color spaces, iterators, locators, views and images.
+However, to work with the rest of GIL they have to satisfy a set of requirements; in other words, they have to \e model the corresponding GIL \e concept.
+GIL's concepts are defined in the user guide.
+
+One of the biggest drawbacks of using
+templates and generic programming in C++ is that compile errors can be very difficult to comprehend.
+This is a side-effect of the lack of early type checking - a generic argument may not satisfy the requirements of a function,
+but the incompatibility may be triggered deep into a nested call, in code unfamiliar and hardly related to the problem.
+GIL uses \p boost::concept_check to mitigate this problem. The above three lines of code check whether the
+template parameters are valid models of their corresponding concepts.
+If a model is incorrect, the compile error will be inside \p gil_function_requires, which is much closer to the problem
+and easier to track. Furthermore, such checks get compiled out and have zero performance overhead. The disadvantage of using
+concept checks is the sometimes severe impact they have on compile time. This is why GIL performs concept checks only in
+debug mode, and only if \p BOOST_GIL_USE_CONCEPT_CHECK is defined (off by default).
+
+The body of the generic function is very similar to that of the concrete one. The biggest difference is that we need to loop over the
+channels of the pixel and compute the gradient for each channel:
+
+\code
+template <typename SrcView, typename DstView>
+void x_gradient(const SrcView& src, const DstView& dst) {
+ for (int y=0; y<src.height(); ++y) {
+ typename SrcView::x_iterator src_it = src.row_begin(y);
+ typename DstView::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=1; x<src.width()-1; ++x)
+ for (int c=0; c<num_channels<SrcView>::value; ++c)
+ dst_it[x][c] = (src_it[x-1][c]- src_it[x+1][c])/2;
+ }
+}
+\endcode
+
+Having an explicit loop for each channel could be a performance problem. GIL allows us to abstract out such per-channel operations:
+
+\code
+template <typename Out>
+struct halfdiff_cast_channels {
+ template <typename T> Out operator()(const T& in1, const T& in2) const {
+ return Out((in1-in2)/2);
+ }
+};
+
+template <typename SrcView, typename DstView>
+void x_gradient(const SrcView& src, const DstView& dst) {
+ typedef typename channel_type<DstView>::type dst_channel_t;
+
+ for (int y=0; y<src.height(); ++y) {
+ typename SrcView::x_iterator src_it = src.row_begin(y);
+ typename DstView::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=1; x<src.width()-1; ++x)
+ static_transform(src_it[x-1], src_it[x+1], dst_it[x],
+ halfdiff_cast_channels<dst_channel_t>());
+ }
+}
+\endcode
+
+\p static_transform is an example of a channel-level GIL algorithm. Other such algorithms are \p static_generate, \p static_fill and \p static_for_each. They are the channel-level equivalents
+of STL's \p generate, \p transform, \p fill and \p for_each respectively. GIL channel algorithms use static recursion to unroll the loops; they never loop over the channels explicitly.
+Note that sometimes modern compilers (at least Visual Studio 8) already unroll channel-level loops, such as the one above. However, another advantage of using
+GIL's channel-level algorithms is that they pair the channels semantically, not based on their order in memory. For example, the above example will properly match an RGB source
+with a BGR destination.
+
+Here is how we can use our generic version with images of different types:
+
+\code
+// Calling with 16-bit grayscale data
+void XGradientGray16_Gray32(const unsigned short* src_pixels, ptrdiff_t src_row_bytes, int w, int h,
+ signed int* dst_pixels, ptrdiff_t dst_row_bytes) {
+ gray16c_view_t src=interleaved_view(w,h,(const gray16_pixel_t*)src_pixels,src_row_bytes);
+ gray32s_view_t dst=interleaved_view(w,h,( gray32s_pixel_t*)dst_pixels,dst_row_bytes);
+ x_gradient(src,dst);
+}
+
+// Calling with 8-bit RGB data into 16-bit BGR
+void XGradientRGB8_BGR16(const unsigned char* src_pixels, ptrdiff_t src_row_bytes, int w, int h,
+ signed short* dst_pixels, ptrdiff_t dst_row_bytes) {
+ rgb8c_view_t src = interleaved_view(w,h,(const rgb8_pixel_t*)src_pixels,src_row_bytes);
+ rgb16s_view_t dst = interleaved_view(w,h,( rgb16s_pixel_t*)dst_pixels,dst_row_bytes);
+ x_gradient(src,dst);
+}
+
+// Either or both the source and the destination could be planar - the gradient code does not change
+void XGradientPlanarRGB8_RGB32(
+ const unsigned short* src_r, const unsigned short* src_g, const unsigned short* src_b,
+ ptrdiff_t src_row_bytes, int w, int h,
+ signed int* dst_pixels, ptrdiff_t dst_row_bytes) {
+ rgb16c_planar_view_t src=planar_rgb_view (w,h, src_r,src_g,src_b, src_row_bytes);
+ rgb32s_view_t dst=interleaved_view(w,h,(rgb32s_pixel_t*)dst_pixels,dst_row_bytes);
+ x_gradient(src,dst);
+}
+\endcode
+
+As these examples illustrate, both the source and the destination can be interleaved or planar, of any channel depth (assuming the destination channel is
+assignable to the source), and of any compatible color spaces.
+
+GIL 2.1 can also natively represent images whose channels are not byte-aligned, such as 6-bit RGB222 image or a 1-bit Gray1 image.
+GIL algorithms apply to these images natively. See the design guide or sample files for more on using such images.
+
+
+
+
+
+
+
+
+
+
+
+
+\subsection ImageViewTransformationSec Image View Transformations
+
+One way to compute the y-gradient is to rotate the image by 90 degrees, compute the x-gradient and rotate the result back. Here is how to do this in GIL:
+
+\code
+template <typename SrcView, typename DstView>
+void y_gradient(const SrcView& src, const DstView& dst) {
+ x_gradient(rotated90ccw_view(src), rotated90ccw_view(dst));
+}
+\endcode
+
+\p rotated90ccw_view takes an image view and returns an image view representing 90-degrees counter-clockwise rotation of its input. It is an example of a GIL view transformation function. GIL provides
+a variety of transformation functions that can perform any axis-aligned rotation, transpose the view, flip it vertically or horizontally, extract a rectangular subimage,
+perform color conversion, subsample view, etc. The view transformation functions are fast and shallow - they don't copy the pixels, they just change the "coordinate system" of
+accessing the pixels. \p rotated90cw_view, for example, returns a view whose horizontal iterators are the vertical iterators of the original view. The above code to compute \p y_gradient
+is slow because of the memory access pattern; using \p rotated90cw_view does not make it any slower.
+
+Another example: suppose we want to compute the gradient of the N-th channel of a color image. Here is how to do that:
+
+\code
+template <typename SrcView, typename DstView>
+void nth_channel_x_gradient(const SrcView& src, int n, const DstView& dst) {
+ x_gradient(nth_channel_view(src, n), dst);
+}
+\endcode
+
+\p nth_channel_view is a view transformation function that takes any view and returns a single-channel (grayscale) view of its N-th channel.
+For interleaved RGB view, for example, the returned view is a step view - a view whose horizontal iterator skips over two channels when incremented.
+If applied on a planar RGB view, the returned type is a simple grayscale view whose horizontal iterator is a C pointer.
+Image view transformation functions can be piped together. For example, to compute the y gradient of the second channel of the even pixels in the view, use:
+
+\code
+y_gradient(subsampled_view(nth_channel_view(src, 1), 2,2), dst);
+\endcode
+
+GIL can sometimes simplify piped views. For example, two nested subsampled views (views that skip over pixels in X and in Y) can be represented as a single subsampled view whose step
+is the product of the steps of the two views.
+
+\subsection OneDIteratorsSec 1D pixel iterators
+
+Let's go back to \p x_gradient one more time.
+Many image view algorithms apply the same operation for each pixel and GIL provides an abstraction to handle them. However, our algorithm has an unusual access pattern, as it skips the
+first and the last column. It would be nice and instructional to see how we can rewrite it in canonical form. The way to do that in GIL is to write a version that works for every pixel, but
+apply it only on the subimage that excludes the first and last column:
+
+\code
+void x_gradient_unguarded(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ for (int y=0; y<src.height(); ++y) {
+ gray8c_view_t::x_iterator src_it = src.row_begin(y);
+ gray8s_view_t::x_iterator dst_it = dst.row_begin(y);
+
+ for (int x=0; x<src.width(); ++x)
+ dst_it[x] = (src_it[x-1] - src_it[x+1]) / 2;
+ }
+}
+
+void x_gradient(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ assert(src.width()>=2);
+ x_gradient_unguarded(subimage_view(src, 1, 0, src.width()-2, src.height()),
+ subimage_view(dst, 1, 0, src.width()-2, src.height()));
+}
+\endcode
+
+\p subimage_view is another example of a GIL view transformation function. It takes a source view and a rectangular region (in this case, defined as x_min,y_min,width,height) and
+returns a view operating on that region of the source view. The above implementation has no measurable performance degradation from the version that operates on the original views.
+
+Now that \p x_gradient_unguarded operates on every pixel, we can rewrite it more compactly:
+
+\code
+void x_gradient_unguarded(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ gray8c_view_t::iterator src_it = src.begin();
+ for (gray8s_view_t::iterator dst_it = dst.begin(); dst_it!=dst.end(); ++dst_it, ++src_it)
+ *dst_it = (src_it.x()[-1] - src_it.x()[1]) / 2;
+}
+\endcode
+
+GIL image views provide \p begin() and \p end() methods that return one dimensional pixel iterators which iterate over each pixel in the view,
+left to right and top to bottom. They do a proper "carriage return" - they skip any unused bytes at the end of a row. As such, they are slightly suboptimal, because they need to keep
+track of their current position with respect to the end of the row. Their increment operator performs one extra check (are we at the end of the row?), a check that is avoided if two
+nested loops are used instead. These iterators have a method \p x() which returns the more lightweight horizontal iterator that we used previously. Horizontal iterators have no
+notion of the end of rows. In this case, the horizontal iterators are raw C pointers. In our example, we must use the horizontal iterators to access the two neighbors properly, since they
+could reside outside the image view.
+
+\subsection STLEquivalentsSec STL Equivalent Algorithms
+
+GIL provides STL equivalents of many algorithms. For example, \p std::transform is an STL algorithm that sets each element in a destination range the result of a generic function taking the
+corresponding element of the source range. In our example, we want to assign to each destination pixel the value of the half-difference of the horizontal neighbors of the corresponding source pixel.
+If we abstract that operation in a function object, we can use GIL's \p transform_pixel_positions to do that:
+
+\code
+struct half_x_difference {
+ int operator()(const gray8c_loc_t& src_loc) const {
+ return (src_loc.x()[-1] - src_loc.x()[1]) / 2;
+ }
+};
+
+void x_gradient_unguarded(const gray8c_view_t& src, const gray8s_view_t& dst) {
+ transform_pixel_positions(src, dst, half_x_difference());
+}
+\endcode
+
+GIL provides the algorithms \p for_each_pixel and \p transform_pixels which are image view equivalents of STL's \p std::for_each and \p std::transform. It also provides
+\p for_each_pixel_position and \p transform_pixel_positions, which instead of references to pixels, pass to the generic function pixel locators. This allows for more powerful functions
+that can use the pixel neighbors through the passed locators.
+GIL algorithms iterate through the pixels using the more efficient two nested loops (as opposed to the single loop using 1-D iterators)
+
+\subsection ColorConversionSec Color Conversion
+
+Instead of computing the gradient of each color plane of an image, we often want to compute the gradient of the luminosity. In other words, we want to convert the
+color image to grayscale and compute the gradient of the result. Here how to compute the luminosity gradient of a 32-bit float RGB image:
+
+\code
+void x_gradient_rgb_luminosity(const rgb32fc_view_t& src, const gray8s_view_t& dst) {
+ x_gradient(color_converted_view<gray8_pixel_t>(src), dst);
+}
+\endcode
+
+\p color_converted_view is a GIL view transformation function that takes any image view and returns a view in a target color space and channel depth (specified
+as template parameters). In our example, it constructs an 8-bit integer grayscale view over 32-bit float RGB pixels. Like all other view transformation functions, \p color_converted_view is very
+fast and shallow. It doesn't copy the data or perform any color conversion. Instead it returns a view that performs color conversion every time its pixels are accessed.
+
+In the generic version of this algorithm we might like to convert the color space to grayscale, but keep the channel depth the same. We do that by constructing the
+type of a GIL grayscale pixel with the same channel as the source, and color convert to that pixel type:
+
+\code
+template <typename SrcView, typename DstView>
+void x_luminosity_gradient(const SrcView& src, const DstView& dst) {
+ typedef pixel<typename channel_type<SrcView>::type, gray_layout_t> gray_pixel_t;
+ x_gradient(color_converted_view<gray_pixel_t>(src), dst);
+}
+\endcode
+
+When the destination color space and channel type happens to be the same as the source one, color conversion is unnecessary. GIL detects this case and avoids calling the color conversion
+code at all - i.e. \p color_converted_view returns back the source view unchanged.
+
+
+\subsection ImagesSec Image
+
+The above example has a performance problem - \p x_gradient dereferences most source pixels twice, which will cause the above code to perform color conversion twice.
+Sometimes it may be more efficient to copy the color converted image into a temporary buffer and use it to compute the gradient - that way color conversion is invoked once per pixel.
+Using our non-generic version we can do it like this:
+
+\code
+void x_luminosity_gradient(const rgb32fc_view_t& src, const gray8s_view_t& dst) {
+ gray8_image_t ccv_image(src.dimensions());
+ copy_pixels(color_converted_view<gray8_pixel_t>(src), view(ccv_image));
+
+ x_gradient(const_view(ccv_image), dst);
+}
+\endcode
+
+First we construct an 8-bit grayscale image with the same dimensions as our source. Then we copy a color-converted view of the source into the temporary image.
+Finally we use a read-only view of the temporary image in our \p x_gradient algorithm. As the example shows, GIL provides global functions \p view and \p const_view
+that take an image and return a mutable or an immutable view of its pixels.
+
+Creating a generic version of the above is a bit trickier:
+
+\code
+template <typename SrcView, typename DstView>
+void x_luminosity_gradient(const SrcView& src, const DstView& dst) {
+ typedef typename channel_type<DstView>::type d_channel_t;
+ typedef typename channel_convert_to_unsigned<d_channel_t>::type channel_t;
+ typedef pixel<channel_t, gray_layout_t> gray_pixel_t;
+ typedef image<gray_pixel_t, false> gray_image_t;
+
+ gray_image_t ccv_image(src.dimensions());
+ copy_pixels(color_converted_view<gray_pixel_t>(src), view(ccv_image));
+ x_gradient(const_view(ccv_image), dst);
+}
+\endcode
+
+First we use the \p channel_type metafunction to get the channel type of the destination view. A metafunction is a function operating on types. In GIL metafunctions
+are structs which take their parameters as template parameters and return their result in a nested typedef called \p type. In this case, \p channel_type is
+a unary metafunction which in this example is called with the type of an image view and returns the type of the channel associated with that image view.
+
+GIL constructs that have an associated pixel type, such as pixels, pixel iterators, locators, views and images, all model \p PixelBasedConcept, which means
+that they provide a set of metafunctions to query the pixel properties, such as \p channel_type, \p color_space_type, \p channel_mapping_type, and \p num_channels.
+
+After we get the channel type of the destination view, we use another metafunction to remove its sign (if it is a signed integral type) and then use it
+to generate the type of a grayscale pixel. From the pixel type we create the image type. GIL's image class is templated over the pixel type and a boolean
+indicating whether the image should be planar or interleaved.
+Single-channel (grayscale) images in GIL must always be interleaved. There are multiple ways of constructing types in GIL. Instead of instantiating the classes
+directly we could have used type factory metafunctions. The following code is equivalent:
+
+\code
+template <typename SrcView, typename DstView>
+void x_luminosity_gradient(const SrcView& src, const DstView& dst) {
+ typedef typename channel_type<DstView>::type d_channel_t;
+ typedef typename channel_convert_to_unsigned<d_channel_t>::type channel_t;
+ typedef typename image_type<channel_t, gray_layout_t>::type gray_image_t;
+ typedef typename gray_image_t::value_type gray_pixel_t;
+
+ gray_image_t ccv_image(src.dimensions());
+ copy_and_convert_pixels(src, view(ccv_image));
+ x_gradient(const_view(ccv_image), dst);
+}
+\endcode
+
+GIL provides a set of metafunctions that generate GIL types - \p image_type is one such meta-function that constructs the type of an image from
+a given channel type, color layout, and planar/interleaved option (the default is interleaved). There are also similar meta-functions to
+construct the types of pixel references, iterators, locators and image views. GIL also has metafunctions \p derived_pixel_reference_type, \p derived_iterator_type,
+\p derived_view_type and \p derived_image_type that construct the type of a GIL construct from a given source one by changing one or more properties of
+the type and keeping the rest.
+
+From the image type we can use the nested typedef \p value_type to obtain the type of a pixel. GIL images, image views and locators have nested typedefs
+\p value_type and \p reference to obtain the type of the pixel and a reference to the pixel. If you have a pixel iterator, you can get these types from its
+\p iterator_traits. Note also the algorithm \p copy_and_convert_pixels, which is an abbreviated version of \p copy_pixels with a color converted source view.
+
+\subsection VirtualViewSec Virtual Image Views
+
+So far we have been dealing with images that have pixels stored in memory. GIL allows you to create an image view of an arbitrary image, including
+a synthetic function. To demonstrate this, let us create a view of the Mandelbrot set.
+First, we need to create a function object that computes the value of the Mandelbrot set at a given location (x,y) in the image:
+\code
+// models PixelDereferenceAdaptorConcept
+struct mandelbrot_fn {
+ typedef point2<ptrdiff_t> point_t;
+
+ typedef mandelbrot_fn const_t;
+ typedef gray8_pixel_t value_type;
+ typedef value_type reference;
+ typedef value_type const_reference;
+ typedef point_t argument_type;
+ typedef reference result_type;
+ BOOST_STATIC_CONSTANT(bool, is_mutable=false);
+
+ mandelbrot_fn() {}
+ mandelbrot_fn(const point_t& sz) : _img_size(sz) {}
+
+ result_type operator()(const point_t& p) const {
+ // normalize the coords to (-2..1, -1.5..1.5)
+ double t=get_num_iter(point2<double>(p.x/(double)_img_size.x*3-2, p.y/(double)_img_size.y*3-1.5f));
+ return value_type((bits8)(pow(t,0.2)*255)); // raise to power suitable for viewing
+ }
+private:
+ point_t _img_size;
+
+ double get_num_iter(const point2<double>& p) const {
+ point2<double> Z(0,0);
+ for (int i=0; i<100; ++i) { // 100 iterations
+ Z = point2<double>(Z.x*Z.x - Z.y*Z.y + p.x, 2*Z.x*Z.y + p.y);
+ if (Z.x*Z.x + Z.y*Z.y > 4)
+ return i/(double)100;
+ }
+ return 0;
+ }
+};
+\endcode
+
+We can now use GIL's \p virtual_2d_locator with this function object to construct a Mandelbrot view of size 200x200 pixels:
+\code
+typedef mandelbrot_fn::point_t point_t;
+typedef virtual_2d_locator<mandelbrot_fn,false> locator_t;
+typedef image_view<locator_t> my_virt_view_t;
+
+point_t dims(200,200);
+
+// Construct a Mandelbrot view with a locator, taking top-left corner (0,0) and step (1,1)
+my_virt_view_t mandel(dims, locator_t(point_t(0,0), point_t(1,1), mandelbrot_fn(dims)));
+\endcode
+
+We can treat the synthetic view just like a real one. For example, let's invoke our \p x_gradient algorithm to compute
+the gradient of the 90-degree rotated view of the Mandelbrot set and save the original and the result:
+
+\code
+gray8s_image_t img(dims);
+x_gradient(rotated90cw_view(mandel), view(img));
+
+// Save the Mandelbrot set and its 90-degree rotated gradient (jpeg cannot save signed char; must convert to unsigned char)
+jpeg_write_view("mandel.jpg",mandel);
+jpeg_write_view("mandel_grad.jpg",color_converted_view<gray8_pixel_t>(const_view(img)));
+\endcode
+
+Here is what the two files look like:
+
+\image html mandel.jpg
+
+\subsection DynamicImageSec Run-Time Specified Images and Image Views
+
+So far we have created a generic function that computes the image gradient of a templated image view.
+Sometimes, however, the properties of an image view, such as its color space and channel depth, may not be available at compile time.
+GIL's \p dynamic_image extension allows for working with GIL constructs that are specified at run time, also called \e variants. GIL provides
+models of a run-time instantiated image, \p any_image, and a run-time instantiated image view, \p any_image_view. The mechanisms are in place to create
+other variants, such as \p any_pixel, \p any_pixel_iterator, etc.
+Most of GIL's algorithms and all of the view transformation functions also work with run-time instantiated image views and binary algorithms, such
+as \p copy_pixels can have either or both arguments be variants.
+
+Lets make our \p x_luminosity_gradient algorithm take a variant image view. For simplicity, let's assume that only the source view can be a variant.
+(As an example of using multiple variants, see GIL's image view algorithm overloads taking multiple variants.)
+
+First, we need to make a function object that contains the templated destination view and has an application operator taking a templated source view:
+
+\code
+#include <boost/gil/extension/dynamic_image/dynamic_image_all.hpp>
+
+template <typename DstView>
+struct x_gradient_obj {
+ typedef void result_type; // required typedef
+
+ const DstView& _dst;
+ x_gradient_obj(const DstView& dst) : _dst(dst) {}
+
+ template <typename SrcView>
+ void operator()(const SrcView& src) const { x_luminosity_gradient(src, _dst); }
+};
+\endcode
+
+The second step is to provide an overload of \p x_luminosity_gradient that takes image view variant and calls GIL's \p apply_operation
+passing it the function object:
+
+\code
+template <typename SrcViews, typename DstView>
+void x_luminosity_gradient(const any_image_view<SrcViews>& src, const DstView& dst) {
+ apply_operation(src, x_gradient_obj<DstView>(dst));
+}
+\endcode
+
+\p any_image_view<SrcViews> is the image view variant. It is templated over \p SrcViews, an enumeration of all possible view types the variant can take.
+\p src contains inside an index of the currently instantiated type, as well as a block of memory containing the instance.
+\p apply_operation goes through a switch statement over the index, each case of which casts the memory to the correct view type and invokes the
+function object with it. Invoking an algorithm on a variant has the overhead of one switch statement. Algorithms that perform an operation for
+each pixel in an image view have practically no performance degradation when used with a variant.
+
+Here is how we can construct a variant and invoke the algorithm:
+
+\code
+#include <boost/mpl/vector.hpp>
+#include <boost/gil/extension/io/jpeg_dynamic_io.hpp>
+
+typedef mpl::vector<gray8_image_t, gray16_image_t, rgb8_image_t, rgb16_image_t> my_img_types;
+any_image<my_img_types> runtime_image;
+jpeg_read_image("input.jpg", runtime_image);
+
+gray8s_image_t gradient(runtime_image.dimensions());
+x_luminosity_gradient(const_view(runtime_image), view(gradient));
+jpeg_write_view("x_gradient.jpg", color_converted_view<gray8_pixel_t>(const_view(gradient)));
+\endcode
+
+In this example, we create an image variant that could be 8-bit or 16-bit RGB or grayscale image. We then use GIL's I/O extension to load the image from file
+in its native color space and channel depth. If none of the allowed image types matches the image on disk, an exception will be thrown.
+We then construct a 8 bit signed (i.e. \p char) image to store the gradient and invoke \p x_gradient on it. Finally we save the result into another file.
+We save the view converted to 8-bit unsigned, because JPEG I/O does not support signed char.
+
+Note how free functions and methods such as \p jpeg_read_image, \p dimensions, \p view and \p const_view work on both templated and variant types.
+For templated images \p view(img) returns a templated view, whereas for image variants it returns a view variant.
+For example, the return type of \p view(runtime_image) is \p any_image_view<Views> where \p Views enumerates four views corresponding to the four image types.
+\p const_view(runtime_image) returns a \p any_image_view of the four read-only view types, etc.
+
+A warning about using variants: instantiating an algorithm with a variant effectively instantiates it with every possible type the variant can take.
+For binary algorithms, the algorithm is instantiated with every possible combination of the two input types! This can take a toll on both the compile time
+and the executable size.
+
+\section ConclusionSec Conclusion
+
+This tutorial provides a glimpse at the challenges associated with writing generic and efficient image processing algorithms in GIL.
+We have taken a simple algorithm and shown how to make it work with image representations that vary in bit depth, color space, ordering of the
+channels, and planar/interleaved structure. We have demonstrated that the algorithm can work with fully abstracted virtual images, and even images
+whose type is specified at run time. The associated video presentation also demonstrates that even for complex scenarios the generated assembly
+is comparable to that of a C version of the algorithm, hand-written for the specific image types.
+
+Yet, even for such a simple algorithm, we are far from making a fully generic and optimized code. In particular, the presented algorithms work on homogeneous
+images, i.e. images whose pixels have channels that are all of the same type. There are examples of images, such as a packed 565 RGB format, which contain
+channels of different types. While GIL provides concepts and algorithms operating on heterogeneous pixels, we leave the task of extending x_gradient as an
+exercise for the reader.
+Second, after computing the value of the gradient we are simply casting it to the destination channel type. This may not always be the desired operation. For
+example, if the source channel is a float with range [0..1] and the destination is unsigned char, casting the half-difference to unsigned char will result in
+either 0 or 1. Instead, what we might want to do is scale the result into the range of the destination channel. GIL's channel-level algorithms might be useful
+in such cases. For example, \p channel_convert converts between channels by linearly scaling the source channel value into the range of the destination channel.
+
+There is a lot to be done in improving the performance as well. Channel-level operations, such as the half-difference, could be abstracted out into atomic
+channel-level algorithms and performance overloads could be provided for concrete channel types. Processor-specific operations could be used, for example,
+to perform the operation over an entire row of pixels simultaneously, or the data could be prefetched. All of these optimizations can be realized as performance
+specializations of the generic algorithm. Finally, compilers, while getting better over time, are still failing to fully optimize generic code in some cases, such
+as failing to inline some functions or put some variables into registers. If performance is an issue, it might be worth trying your code with different compilers.
+
+\section AppendixSec Appendix
+
+\subsection AppendixConventionSec Naming convention for GIL concrete types
+
+Concrete (non-generic) GIL types follow this naming convention:
+
+
+\e ColorSpace + \e BitDepth + [\p f | \p s]+ [\p c] + [\p _planar] + [\p _step] + \e ClassType + \p _t
+
+
+Where \e ColorSpace also indicates the ordering of components. Examples are \p rgb, \p bgr, \p cmyk, \p rgba.
+\e BitDepth indicates the bit depth of the color channel. Examples are \p 8,\p 16,\p 32. By default the type of channel is unsigned integral; using \p s indicates
+signed integral and \p f - a floating point type, which is always signed. \p c indicates object operating over immutable pixels. \p _planar indicates planar organization
+(as opposed to interleaved). \p _step indicates special image views,
+locators and iterators which traverse the data in non-trivial way (for example, backwards or every other pixel).
+\e ClassType is \p _image (image), \p _view (image view), \p _loc (pixel 2D locator) \p _ptr (pixel iterator), \p _ref (pixel reference),
+\p _pixel (pixel value).
+
+\code
+bgr8_image_t a; // 8-bit interleaved BGR image
+cmyk16_pixel_t; b; // 16-bit CMYK pixel value;
+cmyk16c_planar_ref_t c(b); // const reference to a 16-bit planar CMYK pixel x.
+rgb32f_planar_step_ptr_t d; // step pointer to a 32-bit planar RGB pixel.
+\endcode
+
+<div id="footerrow"></div><div id="footer" title="footer: links to copyright and other legal information">Copyright © 2005 Adobe Systems Incorporated<ul id="list1"><li id="terms"><a title="Terms of Use" href="http://www.adobe.com/misc/copyright.html">Terms of Use</a></li><li><a title="Privacy Policy" href="http://www.adobe.com/misc/privacy.html">Privacy Policy</a></li><li>Accessibility</li><li><a title="Avoid software piracy" href="http://www.adobe.com/aboutadobe/antipiracy/main.html">Avoid software piracy</a></li><li id="tms"><a title="Permissions and trademarks" href="http://www.adobe.com/misc/agreement.html">Permissions and trademarks</a></li><li><a title="Product License Agreements" href="http://www.adobe.com/products/eulas/main.html">Product License Agreements</a></li></ul></div>
+
+*/

Next message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r52727 - in trunk/libs/gil/doc: . doxygen/gil_standalone html"
Previous message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r52725 - trunk/libs/config/test"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk