1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
|
/*
* Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
*
* This file is part of Orfeo Toolbox
*
* https://www.orfeo-toolbox.org/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef otbPixelComponentIterator_h
#define otbPixelComponentIterator_h
#include "otbNotNull.h"
#include "otbArrayTraits.h"
#include "otbIteratorHelpers.h"
#include "itkNumericTraits.h"
#include <boost/type_traits/is_complex.hpp>
#include <type_traits>
namespace otb
{
namespace internals
{
/*===============================[ Generic => Arrays ]=======================*/
/**
* Declares an iterator type over pixel components.
* Given a pixel, a component iterator permits to iterates over the
* components of a pixel.
*
* For instance, it can be used to convert from a
* `itk::FixedArray<std::complex<double>, 5>` pixel into a
* `itk::VariableLengthVector<float>` pixel of size 10 with `std::copy()`.
*
* \tparam TPixel Any kind of pixel. It could be a scalar, a
* `std::complex<>`, a statically bound array,
* or a dynamic `itk::VariableLengthVector<>` of
* scalars or even of complexes.
* \tparam ConstOrMutable Tags that tells whether the pixel iterated is
* `const` or mutable.
* \tparam Dispatch Internal type to select the right specialization.
*
* \invariant `m_pixel != nullptr`, statically ensured
* \invariant if not `is_at_end()` then the iterator can be dereferenced
*
* \note This is the internal type, it's not meant to be used directly.
* \sa `otb::PixelComponentIterator`, `otb::PixelComponentConstIterator`,
* `otb::PixelRange()`
* \ingroup OTBImageBaseInternals
*/
template <typename TPixel, typename ConstOrMutable, class Dispatch = void>
class PixelComponentIterator
;
/** Component Iterator specialization for array pixel types.
* \copydoc PixelComponentIterator
*/
template <typename TPixel, typename ConstOrMutable>
class PixelComponentIterator<
TPixel,
ConstOrMutable,
typename std::enable_if_t<mpl::is_array_v<std::decay_t<TPixel>>>>
{
static_assert(mpl::is_array_v<std::decay_t<TPixel>>, "This specialization is reserved to array pixel types");
public:
/**\name ITK Constants and Typedefs */
//@{
static constexpr bool is_const = std::is_same<ConstOrMutable, ConstTag>::value;
static constexpr bool is_mutable = std::is_same<ConstOrMutable, MutableTag>::value;
/** Pixel Type. */
using PixelType = TPixel;
using InternalPixelType = std::remove_reference_t<decltype(std::declval<PixelType>()[0])>;
static constexpr bool is_scalar_array = std::is_arithmetic<InternalPixelType>::value;
using Self = PixelComponentIterator;
using ConstMut_IntPixelType = std::conditional_t<is_const, std::add_const_t<InternalPixelType>, InternalPixelType>;
using SubPixelComponentIteratorType = PixelComponentIterator<ConstMut_IntPixelType, ConstOrMutable>;
using ComponentType = typename SubPixelComponentIteratorType::ComponentType;
/** Run-time type information (and related methods). */
itkTypeMacroNoParent(PixelComponentIterator);
//@}
/**@name C++ std typedefs */
//@{
using difference_type = std::ptrdiff_t;
using value_type = std::conditional_t<is_mutable, InternalPixelType, InternalPixelType const>;
using pointer = value_type *;
using reference = value_type &;
using const_reference = value_type const&;
using iterator_category = std::forward_iterator_tag;
// static_assert(is_const >= std::is_const<InternalPixelType>::value, "should compile");
//@}
/**\name Constructions & Destruction
*
* This class follows the rule of 0/5
*/
//@{
PixelComponentIterator () = default;
~PixelComponentIterator () = default;
PixelComponentIterator (PixelComponentIterator const&) = default;
PixelComponentIterator (PixelComponentIterator &&) = default;
PixelComponentIterator& operator=(PixelComponentIterator const&) = default;
PixelComponentIterator& operator=(PixelComponentIterator &&) = default;
#if 1
/** Conversion constructor.
* Converts from mutable to const iterator
* \see https://quuxplusone.github.io/blog/2018/12/01/const-iterator-antipatterns/
*/
template <bool IsConst_ = is_const, class = std::enable_if_t<IsConst_>>
PixelComponentIterator(PixelComponentIterator<PixelType, MutableTag> const& rhs)
: m_pixel(rhs.m_pixel)
, m_component(rhs.m_component)
, m_subiter(rhs.m_subiter)
{}
/** Conversion move constructor.
* Move converts from mutable to const iterator
* \see https://quuxplusone.github.io/blog/2018/12/01/const-iterator-antipatterns/
*/
template <bool IsConst_ = is_const, class = std::enable_if_t<IsConst_>>
PixelComponentIterator(PixelComponentIterator<PixelType, MutableTag> && rhs)
: m_pixel(rhs.m_pixel)
, m_component(rhs.m_component)
, m_subiter(rhs.m_subiter)
{}
#endif
/**
* Init Constructor.
* Constructs a `PixelComponentIterator` from a pixel
* \param[in,out] pixel Pixel over which components are iterated
*/
explicit PixelComponentIterator(PixelType & pixel, std::size_t component = 0)
: m_pixel(&pixel)
, m_component(component)
, m_subiter(SubPixelComponentIteratorType(get_current_pixel()))
{
assert(component <= mpl::GetNumberOfComponents(*m_pixel));
}
// static_assert(std::is_copy_constructible<Self>::value, "Requires copy construction");
// static_assert(std::is_trivially_copy_constructible<Self>::value, "Requires trivial copy construction");
//@}
/**\name Comparison
* Comparison operators.
* They are all hidden friends. As a consequence, they need to be
* defined within the class definition.
*/
//@{
bool is_at_end() const noexcept
{
return m_component == mpl::GetNumberOfComponents(*m_pixel);
}
friend bool operator==(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
// As is_scalar_array is constexpr it should be optimized away by
// the compiler
return (lhs.m_component == rhs.m_component) && (is_scalar_array || (lhs.m_subiter == rhs.m_subiter));
}
friend bool operator!=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs == rhs); }
friend bool operator<=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
// As is_scalar_array is constexpr it should be optimized away by
// the compiler
return (lhs.m_component <= rhs.m_component)
|| ( !is_scalar_array &&
(lhs.m_component == rhs.m_component) && (lhs.m_subiter <= rhs.m_subiter) );
}
friend bool operator<(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return (lhs.m_component < rhs.m_component)
|| ( !is_scalar_array &&
(lhs.m_component == rhs.m_component) && (lhs.m_subiter < rhs.m_subiter) );
}
friend bool operator>=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs < rhs); }
friend bool operator>(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs <= rhs); }
//@}
/**\name Iterator Interface */
//@{
/** Pre-increments the iterator.
* \pre `! is_at_end()`
*/
Self& operator++()
{
assert(m_component < mpl::GetNumberOfComponents(*m_pixel));
#if defined(__cpp_if_constexpr)
// Optimization for array<scalar> cases
if constexpr(std::is_arithmetic<InternalPixelType>::value)
{
++m_component;
return *this;
}
#endif
++m_subiter;
if (m_subiter.is_at_end())
{
++m_component;
m_subiter = SubPixelComponentIteratorType{get_current_pixel()};
}
return *this;
}
/** Post-increments the iterator.
*/
Self operator++(int)
{
auto tmp = *this;
++(*this);
return tmp;
}
decltype(auto) operator*()
{
// TODO: proxy
// - read: subiter->get_current_pixel()
// - write: set_current_pixel(subiter->set_current_pixel(value))
#if defined(__cpp_if_constexpr)
if constexpr (is_scalar_array)
{
return get_current_pixel();
}
#endif
return *m_subiter;
}
decltype(auto) operator*() const
{
// TODO: proxy
// - read: subiter->get_current_pixel()
// - write: set_current_pixel(subiter->set_current_pixel(value))
#if defined(__cpp_if_constexpr)
if constexpr (is_scalar_array)
{
return get_current_pixel();
}
#endif
return *m_subiter;
}
//@}
auto size() const {
assert(! is_at_end());
auto const shallow_size = mpl::GetNumberOfComponents(*m_pixel);
return shallow_size ? shallow_size * m_subiter.size() : 0U;
}
private:
template <bool IsMutable_ = is_mutable, class = std::enable_if_t<IsMutable_>>
decltype(auto) get_current_pixel()
{
return (*m_pixel)[m_component];
}
decltype(auto) get_current_pixel() const
{
return (*m_pixel)[m_component];
}
NotNull<PixelType*> m_pixel;
std::size_t m_component;
/** Iterator to subcomponents.
* In array cases, components can be array-like pixels like
* `std::complex<>`
*/
SubPixelComponentIteratorType m_subiter;
};
/*===============================[ Complex Numbers ]=========================*/
/** Component Iterator specialization for complex pixel types.
* \copydoc PixelComponentIterator
*/
template <typename TPixel, typename ConstOrMutable>
class PixelComponentIterator<
TPixel,
ConstOrMutable,
typename std::enable_if_t<boost::is_complex<std::decay_t<TPixel>>::value>>
{
public:
/**\name ITK Constants and Typedefs */
//@{
static constexpr bool is_const = std::is_same<ConstOrMutable, ConstTag>::value;
static constexpr bool is_mutable = std::is_same<ConstOrMutable, MutableTag>::value;
/** Pixel Type. */
using PixelType = TPixel;
// using InternalPixelType = typename PixelType::ValueType;
using InternalPixelType = std::remove_reference_t<typename PixelType::value_type>;
using Self = PixelComponentIterator;
using ConstMut_IntPixelType = std::conditional_t<is_const, std::add_const_t<InternalPixelType>, InternalPixelType>;
using SubPixelComponentIteratorType = PixelComponentIterator<ConstMut_IntPixelType, ConstOrMutable>;
using ComponentType = InternalPixelType;
/** Run-time type information (and related methods). */
itkTypeMacroNoParent(PixelComponentIterator);
//@}
/**@name C++ std typedefs */
//@{
using difference_type = std::ptrdiff_t;
using value_type = std::conditional_t<is_mutable, InternalPixelType, InternalPixelType const>;
using pointer = value_type *;
using reference = value_type &;
using const_reference = value_type const&;
using iterator_category = std::forward_iterator_tag;
// static_assert(is_const >= std::is_const<InternalPixelType>::value, "should compile");
//@}
/**\name Constructions & Destruction
*
* This class follows the rule of 0/5
*/
//@{
PixelComponentIterator () = default;
~PixelComponentIterator () = default;
PixelComponentIterator (PixelComponentIterator const&) = default;
PixelComponentIterator (PixelComponentIterator &&) = default;
PixelComponentIterator& operator=(PixelComponentIterator const&) = default;
PixelComponentIterator& operator=(PixelComponentIterator &&) = default;
#if 1
/** Conversion constructor.
* Converts from mutable to const iterator
* \see https://quuxplusone.github.io/blog/2018/12/01/const-iterator-antipatterns/
*/
template <bool IsConst_ = is_const, class = std::enable_if_t<IsConst_>>
PixelComponentIterator(PixelComponentIterator<PixelType, MutableTag> const& rhs)
: m_pixel(rhs.m_pixel)
, m_component(rhs.m_component)
{}
/** Conversion move constructor.
* Move converts from mutable to const iterator
* \see https://quuxplusone.github.io/blog/2018/12/01/const-iterator-antipatterns/
*/
template <bool IsConst_ = is_const, class = std::enable_if_t<IsConst_>>
PixelComponentIterator(PixelComponentIterator<PixelType, MutableTag> && rhs)
: m_pixel(rhs.m_pixel)
, m_component(rhs.m_component)
{}
#endif
/**
* Init Constructor.
* Constructs a `PixelComponentIterator` from a pixel
* \param[in,out] pixel Pixel over which components are iterated
*/
explicit PixelComponentIterator(PixelType & pixel, std::size_t component = 0)
: m_pixel(&pixel)
, m_component(component)
{
assert(component <= 2);
}
// static_assert(std::is_copy_constructible<Self>::value, "Requires copy construction");
// static_assert(std::is_trivially_copy_constructible<Self>::value, "Requires trivial copy construction");
//@}
/**\name Comparison
* Comparison operators.
* They are all hidden friends. As a consequence, they need to be
* defined within the class definition.
*/
//@{
bool is_at_end() const noexcept
{
return m_component == 2;
}
friend bool operator==(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return lhs.m_component == rhs.m_component;
}
friend bool operator!=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs == rhs); }
friend bool operator<=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return lhs.m_component <= rhs.m_component;
}
friend bool operator<(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return lhs.m_component < rhs.m_component;
}
friend bool operator>=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs < rhs); }
friend bool operator>(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs <= rhs); }
//@}
/**\name Iterator Interface */
//@{
/** Pre-increment the iterator.
* \pre `! is_at_end()`
*/
Self& operator++()
{
// assert(m_component < size(*m_pixel));
++m_component;
return *this;
}
/** Post-increment the iterator.
*/
Self operator++(int)
{
auto tmp = *this;
++(*this);
return tmp;
}
decltype(auto) operator*()
{
// TODO: proxy
// - read: subiter->get_current_pixel()
// - write: set_current_pixel(subiter->set_current_pixel(value))
return get_current_pixel();
}
decltype(auto) operator*() const
{
// TODO: proxy
// - read: subiter->get_current_pixel()
// - write: set_current_pixel(subiter->set_current_pixel(value))
return get_current_pixel();
}
//@}
constexpr std::size_t size() const noexcept {
assert(! is_at_end());
return 2;
}
private:
template <bool IsMutable_ = is_mutable, class = std::enable_if_t<IsMutable_>>
decltype(auto) get_current_pixel()
{
return reinterpret_cast<value_type(&)[2]>((*m_pixel))[m_component];
}
decltype(auto) get_current_pixel() const
{
// Guaranteed compatibility with array of components since C++11
return reinterpret_cast<value_type(&)[2]>((*m_pixel))[m_component];
}
NotNull<PixelType*> m_pixel;
std::size_t m_component;
};
/*===============================[ Numbers ]=================================*/
/** Component Iterator specialization for scalar pixel types.
* \copydoc PixelComponentIterator
*/
template <typename TPixel, typename ConstOrMutable>
class PixelComponentIterator<TPixel, ConstOrMutable, typename std::enable_if_t<std::is_arithmetic<TPixel>::value>>
{
static_assert(std::is_arithmetic<TPixel>::value, "Specialization for scalar pixels");
public:
/**\name ITK Constants and Typedefs */
//@{
static constexpr bool is_const = std::is_same<ConstOrMutable, ConstTag>::value;
static constexpr bool is_mutable = std::is_same<ConstOrMutable, MutableTag>::value;
/** Pixel Type. */
using PixelType = TPixel;
// using InternalPixelType = TPixel;
using ComponentType = PixelType;
using Self = PixelComponentIterator;
/** Run-time type information (and related methods). */
itkTypeMacroNoParent(PixelComponentIterator);
//@}
/**@name C++ std typedefs */
//@{
using difference_type = std::ptrdiff_t;
using value_type = std::conditional_t<is_mutable, PixelType, PixelType const>;
using pointer = value_type *;
using reference = value_type &;
using const_reference = value_type const&;
using iterator_category = std::forward_iterator_tag;
// static_assert(is_const >= std::is_const<PixelType>::value, "should compile");
//@}
/**\name Constructions & Destruction
*
* This class follows the rule of 0/5
*/
//@{
PixelComponentIterator () = default;
~PixelComponentIterator () = default;
PixelComponentIterator (PixelComponentIterator const&) = default;
PixelComponentIterator (PixelComponentIterator &&) = default;
PixelComponentIterator& operator=(PixelComponentIterator const&) = default;
PixelComponentIterator& operator=(PixelComponentIterator &&) = default;
#if 1
/** Conversion constructor.
* Converts from mutable to const iterator
* \see https://quuxplusone.github.io/blog/2018/12/01/const-iterator-antipatterns/
*/
template <bool IsConst_ = is_const, class = std::enable_if_t<IsConst_>>
PixelComponentIterator(PixelComponentIterator<PixelType, MutableTag> const& rhs) noexcept
: m_pixel(rhs.m_pixel)
, m_component(rhs.m_component)
{}
/** Conversion move constructor.
* Move converts from mutable to const iterator
* \see https://quuxplusone.github.io/blog/2018/12/01/const-iterator-antipatterns/
*/
template <bool IsConst_ = is_const, class = std::enable_if_t<IsConst_>>
PixelComponentIterator(PixelComponentIterator<PixelType, MutableTag> && rhs) noexcept
: m_pixel(rhs.m_pixel)
, m_component(rhs.m_component)
{}
#endif
/**
* Init Constructor.
* Constructs a `PixelComponentIterator` from a pixel
* \param[in,out] pixel Pixel over which components are iterated
*/
explicit PixelComponentIterator(PixelType& pixel, std::size_t component = 0) noexcept
: m_pixel(&pixel)
, m_component(component)
{}
// static_assert(std::is_copy_constructible<Self>::value, "Requires copy construction");
// static_assert(std::is_trivially_copy_constructible<Self>::value, "Requires trivial copy construction");
//@}
/**\name Comparison
* Comparison operators.
* They are all hidden friends. As a consequence, they need to be
* defined within the class definition.
*/
//@{
bool is_at_end() const noexcept
{
return m_component == mpl::GetNumberOfComponents(*m_pixel);
}
friend bool operator==(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return lhs.m_component == rhs.m_component;
}
friend bool operator!=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs == rhs); }
friend bool operator<=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return lhs.m_component <= rhs.m_component;
}
friend bool operator<(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{
assert(lhs.m_pixel == rhs.m_pixel);
return lhs.m_component < rhs.m_component;
}
friend bool operator>=(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs < rhs); }
friend bool operator>(PixelComponentIterator const& lhs, PixelComponentIterator const& rhs) noexcept
{ return ! (lhs <= rhs); }
//@}
/**\name Iterator Interface */
//@{
/** Pre-increment the iterator.
* \pre `! is_at_end()`
*/
Self& operator++() noexcept
{
assert(m_component < 1);
++m_component;
return *this;
}
/** Post-increment the iterator.
*/
Self operator++(int) noexcept
{
auto tmp = *this;
++(*this);
return tmp;
}
#if 0
PixelType & get_current_pixel() noexcept
{
return *m_pixel;
}
PixelType const& get_current_pixel() const noexcept
{
return *m_pixel;
}
#endif
decltype(auto) operator*() const noexcept
{
return *m_pixel;
}
decltype(auto) operator*() noexcept
{
return *m_pixel;
}
//@}
bool end() const noexcept { return m_component > 0; }
constexpr std::size_t size() const noexcept {
assert(! is_at_end());
return 1;
}
private:
NotNull<PixelType*> m_pixel;
std::size_t m_component;
};
} // otb::internal namespace
template <typename TPixel>
using PixelComponentIterator = internals::PixelComponentIterator<TPixel, std::conditional_t<std::is_const<TPixel>::value, internals::ConstTag, internals::MutableTag>>;
template <typename TPixel>
using PixelComponentConstIterator = internals::PixelComponentIterator<TPixel, internals::ConstTag>;
/**
* Helper type for defining a range of pixel components.
* \tparam TPixel Pixel type
*
* \invariant `begin() <= end()`
* \invariant `m_pixel != nullptr`
* \invariant `std::distance(begin(), end()) == shallow_size() ? shallow_size() * mpl::GetNumberOfComponents(*begin()) : 0`
*/
template <typename TPixel>
struct PixelRange_t
{
using PixelType = TPixel;
using iterator = otb::PixelComponentIterator<PixelType>;
using const_iterator = otb::PixelComponentConstIterator<PixelType>;
using value_type = typename iterator::ComponentType;
using size_type = unsigned long;
using difference_type = long;
explicit PixelRange_t(PixelType & pixel) : m_pixel(&pixel) {}
auto begin() { return otb::PixelComponentIterator<PixelType>{*m_pixel, 0U}; }
auto end() { return otb::PixelComponentIterator<PixelType>{*m_pixel, shallow_size()}; }
// TODO: GOTO last
auto begin() const { return otb::PixelComponentConstIterator<PixelType>{*m_pixel, 0U}; }
auto end() const { return otb::PixelComponentConstIterator<PixelType>{*m_pixel, shallow_size()}; }
auto cbegin() const { return otb::PixelComponentConstIterator<PixelType>{*m_pixel, 0U}; }
auto cend() const { return otb::PixelComponentConstIterator<PixelType>{*m_pixel, shallow_size()}; }
size_type shallow_size() const /*noexcept*/ { return mpl::GetNumberOfComponents(*m_pixel);}
size_type size() const {
auto const sh_size = shallow_size();
return sh_size ? begin().size() : 0U;
}
private:
NotNull<PixelType*> m_pixel;
};
#if 1
template <typename TPixel>
inline
auto PixelRange(TPixel && pixel)
{
// return PixelRange_t<TPixel>{pixel};
static_assert(! std::is_rvalue_reference<decltype(std::forward<TPixel>(pixel))>::value, "Cannot build component iterator over rvalue pixels");
return PixelRange_t<std::remove_reference_t<TPixel>>{pixel};
}
#else
template <typename TPixel>
inline
auto PixelRange(TPixel & pixel)
{
return internals::PixelRange_t<TPixel>{pixel};
}
template <typename TPixel>
inline
auto PixelRange(TPixel const& pixel)
{
return internals::PixelRange_t<TPixel const>{pixel};
}
#endif
} // end namespace otb
#endif
|