otb::PixelRange_t< TPixel > Struct Template Reference

#include <otbPixelComponentIterator.h>

Collaboration diagram for otb::PixelRange_t< TPixel >:

Public Types
using	const_iterator = otb::PixelComponentConstIterator< PixelType >
using	difference_type = long
using	iterator = otb::PixelComponentIterator< PixelType >
using	PixelType = TPixel
using	size_type = unsigned long
using	value_type = typename iterator::ComponentType

Public Member Functions
auto	begin ()
auto	begin () const
auto	cbegin () const
auto	cend () const
auto	end ()
auto	end () const
	PixelRange_t (PixelType &pixel)
size_type	shallow_size () const
size_type	size () const

Private Attributes
NotNull< PixelType * >	m_pixel

Detailed Description

template<typename TPixel>
struct otb::PixelRange_t< TPixel >

Helper type for defining a range of pixel components.

Template Parameters

TPixel

Pixel type

Invariant

begin() <= end()

m_pixel != nullptr

std::distance(begin(), end()) == shallow_size() ? shallow_size() * mpl::GetNumberOfComponents(*begin()) : 0

Definition at line 683 of file otbPixelComponentIterator.h.

Member Typedef Documentation

const_iterator

template<typename TPixel >

using otb::PixelRange_t< TPixel >::const_iterator = otb::PixelComponentConstIterator<PixelType>

Definition at line 688 of file otbPixelComponentIterator.h.

difference_type

template<typename TPixel >

using otb::PixelRange_t< TPixel >::difference_type = long

Definition at line 691 of file otbPixelComponentIterator.h.

iterator

template<typename TPixel >

using otb::PixelRange_t< TPixel >::iterator = otb::PixelComponentIterator<PixelType>

Definition at line 687 of file otbPixelComponentIterator.h.

PixelType

template<typename TPixel >

using otb::PixelRange_t< TPixel >::PixelType = TPixel

Definition at line 685 of file otbPixelComponentIterator.h.

size_type

template<typename TPixel >

using otb::PixelRange_t< TPixel >::size_type = unsigned long

Definition at line 690 of file otbPixelComponentIterator.h.

value_type

template<typename TPixel >

using otb::PixelRange_t< TPixel >::value_type = typename iterator::ComponentType

Definition at line 689 of file otbPixelComponentIterator.h.

Constructor & Destructor Documentation

PixelRange_t()

template<typename TPixel >

otb::PixelRange_t< TPixel >::PixelRange_t ( PixelType &  pixel )

inlineexplicit

Definition at line 693 of file otbPixelComponentIterator.h.

Member Function Documentation

begin() [1/2]

template<typename TPixel >

auto otb::PixelRange_t< TPixel >::begin ( )

inline

Definition at line 694 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::m_pixel.

Referenced by otb::PixelRange_t< TPixel >::size().

begin() [2/2]

template<typename TPixel >

auto otb::PixelRange_t< TPixel >::begin ( ) const

inline

Definition at line 698 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::m_pixel.

cbegin()

template<typename TPixel >

auto otb::PixelRange_t< TPixel >::cbegin ( ) const

inline

Definition at line 700 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::m_pixel.

cend()

template<typename TPixel >

auto otb::PixelRange_t< TPixel >::cend ( ) const

inline

Definition at line 701 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::m_pixel, and otb::PixelRange_t< TPixel >::shallow_size().

end() [1/2]

template<typename TPixel >

auto otb::PixelRange_t< TPixel >::end ( )

inline

Definition at line 695 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::m_pixel, and otb::PixelRange_t< TPixel >::shallow_size().

end() [2/2]

template<typename TPixel >

auto otb::PixelRange_t< TPixel >::end ( ) const

inline

Definition at line 699 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::m_pixel, and otb::PixelRange_t< TPixel >::shallow_size().

shallow_size()

template<typename TPixel >

size_type otb::PixelRange_t< TPixel >::shallow_size ( ) const

inline

Definition at line 703 of file otbPixelComponentIterator.h.

References otb::mpl::GetNumberOfComponents(), and otb::PixelRange_t< TPixel >::m_pixel.

Referenced by otb::PixelRange_t< TPixel >::cend(), otb::PixelRange_t< TPixel >::end(), and otb::PixelRange_t< TPixel >::size().

size()

template<typename TPixel >

size_type otb::PixelRange_t< TPixel >::size ( ) const

inline

Definition at line 704 of file otbPixelComponentIterator.h.

References otb::PixelRange_t< TPixel >::begin(), and otb::PixelRange_t< TPixel >::shallow_size().

Member Data Documentation

m_pixel

template<typename TPixel >

NotNull<PixelType*> otb::PixelRange_t< TPixel >::m_pixel

private

Definition at line 709 of file otbPixelComponentIterator.h.

Referenced by otb::PixelRange_t< TPixel >::begin(), otb::PixelRange_t< TPixel >::cbegin(), otb::PixelRange_t< TPixel >::cend(), otb::PixelRange_t< TPixel >::end(), and otb::PixelRange_t< TPixel >::shallow_size().

---

The documentation for this struct was generated from the following file:

• otbPixelComponentIterator.h