virtual_locator.hpp 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. //
  2. // Copyright 2005-2007 Adobe Systems Incorporated
  3. //
  4. // Distributed under the Boost Software License, Version 1.0
  5. // See accompanying file LICENSE_1_0.txt or copy at
  6. // http://www.boost.org/LICENSE_1_0.txt
  7. //
  8. #ifndef BOOST_GIL_VIRTUAL_LOCATOR_HPP
  9. #define BOOST_GIL_VIRTUAL_LOCATOR_HPP
  10. #include <boost/gil/dynamic_step.hpp>
  11. #include <boost/gil/position_iterator.hpp>
  12. #include <boost/assert.hpp>
  13. #include <boost/iterator/iterator_facade.hpp>
  14. namespace boost { namespace gil {
  15. /// \brief A 2D locator over a virtual image. Upon dereferencing, invokes a given function object passing it its coordinates. Models: PixelLocatorConcept, HasDynamicXStepTypeConcept, HasDynamicYStepTypeConcept, HasTransposedTypeConcept
  16. /// \ingroup PixelLocatorModel PixelBasedModel
  17. ///
  18. template <typename Deref, bool IsTransposed> // A function object that given a point returns a reference. Models PixelDereferenceAdaptorConcept
  19. class virtual_2d_locator : public pixel_2d_locator_base<virtual_2d_locator<Deref,IsTransposed>, position_iterator<Deref,IsTransposed>, position_iterator<Deref,1-IsTransposed>>
  20. {
  21. using this_t = virtual_2d_locator<Deref,IsTransposed>;
  22. public:
  23. using parent_t = pixel_2d_locator_base<virtual_2d_locator<Deref,IsTransposed>, position_iterator<Deref,IsTransposed>, position_iterator<Deref,1-IsTransposed>>;
  24. using const_t = virtual_2d_locator<typename Deref::const_t,IsTransposed>;
  25. using deref_fn_t = Deref;
  26. using point_t = typename parent_t::point_t;
  27. using coord_t = typename parent_t::coord_t;
  28. using x_coord_t = typename parent_t::x_coord_t;
  29. using y_coord_t = typename parent_t::y_coord_t;
  30. using x_iterator = typename parent_t::x_iterator;
  31. using y_iterator = typename parent_t::y_iterator;
  32. template <typename NewDeref> struct add_deref
  33. {
  34. using type = virtual_2d_locator<deref_compose<NewDeref,Deref>,IsTransposed>;
  35. static type make(const virtual_2d_locator<Deref,IsTransposed>& loc, const NewDeref& nderef) {
  36. return type(loc.pos(), loc.step(), deref_compose<NewDeref,Deref>(nderef,loc.deref_fn()));
  37. }
  38. };
  39. virtual_2d_locator(const point_t& p=point_t(0,0), const point_t& step=point_t(1,1), const deref_fn_t& d=deref_fn_t()) : _p(p,step,d) {}
  40. template <typename D, bool TR> virtual_2d_locator(const virtual_2d_locator<D,TR>& loc, coord_t y_step)
  41. : _p(loc.pos(), point_t(loc.step().x,loc.step().y*y_step), loc.deref_fn()) {}
  42. template <typename D, bool TR>
  43. virtual_2d_locator(virtual_2d_locator<D, TR> const& loc, coord_t x_step, coord_t y_step, bool transpose = false)
  44. : _p(loc.pos()
  45. , transpose ?
  46. point_t(loc.step().x * y_step, loc.step().y * x_step) :
  47. point_t(loc.step().x * x_step, loc.step().y * y_step)
  48. , loc.deref_fn())
  49. {
  50. BOOST_ASSERT(transpose == (IsTransposed != TR));
  51. }
  52. template <typename D, bool TR> virtual_2d_locator(const virtual_2d_locator<D,TR>& pl) : _p(pl._p) {}
  53. virtual_2d_locator(const virtual_2d_locator& pl) : _p(pl._p) {}
  54. bool operator==(const this_t& p) const { return _p==p._p; }
  55. x_iterator& x() { return *gil_reinterpret_cast<x_iterator*>(this); }
  56. y_iterator& y() { return _p; }
  57. x_iterator const& x() const { return *gil_reinterpret_cast_c<x_iterator const*>(this); }
  58. y_iterator const& y() const { return _p; }
  59. // Returns the y distance between two x_iterators given the difference of their x positions
  60. y_coord_t y_distance_to(const this_t& it2, x_coord_t) const { return (it2.pos()[1-IsTransposed] - pos()[1-IsTransposed])/step()[1-IsTransposed]; }
  61. bool is_1d_traversable(x_coord_t) const { return false; } // is there no gap at the end of each row? I.e. can we use x_iterator to visit every pixel instead of nested loops?
  62. // Methods specific for virtual 2D locator
  63. const point_t& pos() const { return _p.pos(); }
  64. const point_t& step() const { return _p.step(); }
  65. const deref_fn_t& deref_fn() const { return _p.deref_fn(); }
  66. private:
  67. template <typename D, bool TR> friend class virtual_2d_locator;
  68. y_iterator _p; // contains the current position, the step and the dereference object
  69. };
  70. /////////////////////////////
  71. // PixelBasedConcept
  72. /////////////////////////////
  73. template <typename D, bool TR>
  74. struct channel_type<virtual_2d_locator<D,TR> > : public channel_type<typename virtual_2d_locator<D,TR>::parent_t> {
  75. };
  76. template <typename D, bool TR>
  77. struct color_space_type<virtual_2d_locator<D,TR> > : public color_space_type<typename virtual_2d_locator<D,TR>::parent_t> {
  78. };
  79. template <typename D, bool TR>
  80. struct channel_mapping_type<virtual_2d_locator<D,TR> > : public channel_mapping_type<typename virtual_2d_locator<D,TR>::parent_t> {
  81. };
  82. template <typename D, bool TR>
  83. struct is_planar<virtual_2d_locator<D,TR> > : public is_planar<typename virtual_2d_locator<D,TR>::parent_t> {
  84. };
  85. /////////////////////////////
  86. // HasDynamicXStepTypeConcept
  87. /////////////////////////////
  88. template <typename D, bool TR>
  89. struct dynamic_x_step_type<virtual_2d_locator<D,TR>>
  90. {
  91. using type = virtual_2d_locator<D,TR>;
  92. };
  93. /////////////////////////////
  94. // HasDynamicYStepTypeConcept
  95. /////////////////////////////
  96. template <typename D, bool TR>
  97. struct dynamic_y_step_type<virtual_2d_locator<D,TR>>
  98. {
  99. using type = virtual_2d_locator<D,TR>;
  100. };
  101. /////////////////////////////
  102. // HasTransposedTypeConcept
  103. /////////////////////////////
  104. template <typename D, bool IsTransposed>
  105. struct transposed_type<virtual_2d_locator<D,IsTransposed>>
  106. {
  107. using type = virtual_2d_locator<D,1-IsTransposed>;
  108. };
  109. }} // namespace boost::gil
  110. #endif