2 Copyright 2005-2007 Adobe Systems Incorporated
4 Use, modification and distribution are subject to the Boost Software License,
5 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
6 http://www.boost.org/LICENSE_1_0.txt).
8 See http://opensource.adobe.com/gil for most recent version including documentation.
11 /*************************************************************************************************/
13 #ifndef GIL_DYNAMICIMAGE_ANY_IMAGEVIEW_HPP
14 #define GIL_DYNAMICIMAGE_ANY_IMAGEVIEW_HPP
16 ////////////////////////////////////////////////////////////////////////////////////////
18 /// \brief Support for run-time instantiated image view
19 /// \author Lubomir Bourdev and Hailin Jin \n
20 /// Adobe Systems Incorporated
23 ////////////////////////////////////////////////////////////////////////////////////////
25 #include "variant.hpp"
26 #include "../../image_view.hpp"
27 #include "../../image.hpp"
29 namespace boost { namespace gil {
32 template <typename View> struct get_const_t { typedef typename View::const_t type; };
33 template <typename Views> struct views_get_const_t : public mpl::transform<Views, get_const_t<mpl::_1> > {};
35 template <typename View> struct dynamic_xy_step_type;
36 template <typename View> struct dynamic_xy_step_transposed_type;
39 struct any_type_get_num_channels { // works for both image_view and image
40 typedef int result_type;
41 template <typename T> result_type operator()(const T& v) const { return num_channels<T>::value; }
43 struct any_type_get_dimensions { // works for both image_view and image
44 typedef point2<std::ptrdiff_t> result_type;
45 template <typename T> result_type operator()(const T& v) const { return v.dimensions(); }
49 ////////////////////////////////////////////////////////////////////////////////////////
50 /// CLASS any_image_view
52 /// \ingroup ImageViewModel
53 /// \brief Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeConcept, Note that this class does NOT model ImageViewConcept
55 /// Represents a view whose type (color space, layout, planar/interleaved organization, etc) can be specified at run time.
56 /// It is the runtime equivalent of \p image_view.
57 /// Some of the requirements of ImageViewConcept, such as the \p value_type typedef cannot be fulfilled, since the language does not allow runtime type specification.
58 /// Other requirements, such as access to the pixels, would be inefficient to provide. Thus \p any_image_view does not fully model ImageViewConcept.
59 /// However, many algorithms provide overloads taking runtime specified views and thus in many cases \p any_image_view can be used in places taking a view.
61 /// To perform an algorithm on any_image_view, put the algorithm in a function object and invoke it by calling \p apply_operation(runtime_view, algorithm_fn);
62 ////////////////////////////////////////////////////////////////////////////////////////
63 template <typename ImageViewTypes>
64 class any_image_view : public variant<ImageViewTypes> {
65 typedef variant<ImageViewTypes> parent_t;
67 typedef any_image_view<typename detail::views_get_const_t<ImageViewTypes>::type> const_t;
68 typedef std::ptrdiff_t x_coord_t;
69 typedef std::ptrdiff_t y_coord_t;
70 typedef point2<std::ptrdiff_t> point_t;
72 any_image_view() : parent_t() {}
73 template <typename T> explicit any_image_view(const T& obj) : parent_t(obj) {}
74 any_image_view(const any_image_view& v) : parent_t((const parent_t&)v) {}
76 template <typename T> any_image_view& operator=(const T& obj) { parent_t::operator=(obj); return *this; }
77 any_image_view& operator=(const any_image_view& v) { parent_t::operator=((const parent_t&)v); return *this;}
79 std::size_t num_channels() const { return apply_operation(*this, detail::any_type_get_num_channels()); }
80 point_t dimensions() const { return apply_operation(*this, detail::any_type_get_dimensions()); }
81 x_coord_t width() const { return dimensions().x; }
82 y_coord_t height() const { return dimensions().y; }
85 /////////////////////////////
86 // HasDynamicXStepTypeConcept
87 /////////////////////////////
89 template <typename IVTypes>
90 struct dynamic_x_step_type<any_image_view<IVTypes> > {
91 typedef any_image_view<typename mpl::transform<IVTypes, dynamic_x_step_type<mpl::_1> >::type> type;
94 /////////////////////////////
95 // HasDynamicYStepTypeConcept
96 /////////////////////////////
98 template <typename IVTypes>
99 struct dynamic_y_step_type<any_image_view<IVTypes> > {
100 typedef any_image_view<typename mpl::transform<IVTypes, dynamic_y_step_type<mpl::_1> >::type> type;
103 template <typename IVTypes>
104 struct dynamic_xy_step_type<any_image_view<IVTypes> > {
105 typedef any_image_view<typename mpl::transform<IVTypes, dynamic_xy_step_type<mpl::_1> >::type> type;
108 template <typename IVTypes>
109 struct dynamic_xy_step_transposed_type<any_image_view<IVTypes> > {
110 typedef any_image_view<typename mpl::transform<IVTypes, dynamic_xy_step_transposed_type<mpl::_1> >::type> type;
113 } } // namespace boost::gil