Immutable pixel iterator. More...

#include <Image.h>

Inherited by pcl::GenericImage::filter_pixel_iterator_base< const GenericImage, const_pixel_iterator, const sample *, F >.

Public Types
using	image_type = GenericImage< P >

using	pixel_traits = typename image_type::pixel_traits

using	sample = typename image_type::sample

Public Member Functions
	const_pixel_iterator ()=default

	const_pixel_iterator (const const_pixel_iterator &)=default

	const_pixel_iterator (const image_type &image)

const image_type &	Image () const noexcept

bool	IsValid () const noexcept

const_pixel_iterator &	MoveBy (int dx, int dy) noexcept

	operator bool () const noexcept

const_pixel_iterator &	operator++ () noexcept

const_pixel_iterator	operator++ (int) noexcept

const_pixel_iterator &	operator+= (distance_type delta) noexcept

const_pixel_iterator &	operator-- () noexcept

const_pixel_iterator	operator-- (int) noexcept

const_pixel_iterator &	operator-= (distance_type delta) noexcept

const_pixel_iterator &	operator= (const const_pixel_iterator &)=default

const sample &	operator[] (int channel) const noexcept

const sample *	Position (int channel) const noexcept

Friends
const_pixel_iterator	operator+ (const const_pixel_iterator &i, distance_type delta) noexcept

const_pixel_iterator	operator+ (distance_type delta, const const_pixel_iterator &i) noexcept

distance_type	operator- (const const_pixel_iterator &i, const const_pixel_iterator &j) noexcept

const_pixel_iterator	operator- (const const_pixel_iterator &i, distance_type delta) noexcept

bool	operator< (const const_pixel_iterator &i, const const_pixel_iterator &j) noexcept

bool	operator== (const const_pixel_iterator &i, const const_pixel_iterator &j) noexcept

Detailed Description

template<class P>
class pcl::GenericImage::const_pixel_iterator

An immutable pixel iterator provides read-only, random access to all pixels of an image.

Definition at line 3746 of file Image.h.

Member Typedef Documentation

◆ image_type

template<class P >

using pcl::GenericImage::const_pixel_iterator::image_type = GenericImage

Represents the type of the iterated image.

Definition at line 3753 of file Image.h.

◆ pixel_traits

template<class P >

using pcl::GenericImage::const_pixel_iterator::pixel_traits = typename image_type::pixel_traits

Represents the pixel traits class used by the iterated image.

Definition at line 3758 of file Image.h.

◆ sample

template<class P >

using pcl::GenericImage::const_pixel_iterator::sample = typename image_type::sample

Represents a pixel sample of the iterated image.

Definition at line 3763 of file Image.h.

Constructor & Destructor Documentation

◆ const_pixel_iterator() [1/3]

template<class P >

pcl::GenericImage::const_pixel_iterator::const_pixel_iterator ( )

default

Default constructor. Initializes an invalid iterator.

◆ const_pixel_iterator() [2/3]

template<class P >

pcl::GenericImage::const_pixel_iterator::const_pixel_iterator ( const image_type & image )

inline

Constructs an immutable pixel iterator for the specified image.

Definition at line 3775 of file Image.h.

◆ const_pixel_iterator() [3/3]

template<class P >

pcl::GenericImage::const_pixel_iterator::const_pixel_iterator ( const const_pixel_iterator & )

default

Copy constructor.

Member Function Documentation

◆ Image()

template<class P >

const image_type& pcl::GenericImage::const_pixel_iterator::Image ( ) const

inlinenoexcept

Returns a reference to the constant image being iterated by this object.

Definition at line 3810 of file Image.h.

◆ IsValid()

template<class P >

bool pcl::GenericImage::const_pixel_iterator::IsValid ( ) const

inlinenoexcept

Returns true only if this iterator is valid. A valid iterator defines a valid iterated image and a non-null position.

Definition at line 3801 of file Image.h.

◆ MoveBy()

template<class P >

const_pixel_iterator& pcl::GenericImage< P >::const_pixel_iterator::MoveBy	(	int	dx,
		int	dy
	)

inlinenoexcept

Moves this iterator on the iterated image by the specified horizontal and vertical increments in pixels, dx and dy respectively, relative to its current position. Positive (negative) dx increments move the iterator rightwards (leftwards). Positive (negative) dy increments move the iterator downwards (upwards).

Definition at line 3926 of file Image.h.

◆ operator bool()

template<class P >

pcl::GenericImage::const_pixel_iterator::operator bool ( ) const

inlinenoexcept

Boolean type conversion operator. Returns true if this iterator is active. A pixel iterator is active if it has not reached (or surpassed) its iteration limit.

Definition at line 3829 of file Image.h.

◆ operator++() [1/2]

template<class P >

const_pixel_iterator& pcl::GenericImage::const_pixel_iterator::operator++ ( )

inlinenoexcept

Pre-increment operator. Causes this iterator to point to the next pixel in the iterated image. Returns a reference to this iterator.

Definition at line 3847 of file Image.h.

◆ operator++() [2/2]

template<class P >

const_pixel_iterator pcl::GenericImage::const_pixel_iterator::operator++ ( int )

inlinenoexcept

Post-increment operator. Causes this iterator to point to the next pixel in the iterated image. Returns a copy of the iterator as it was before incrementing it.

Definition at line 3859 of file Image.h.

◆ operator+=()

template<class P >

const_pixel_iterator& pcl::GenericImage::const_pixel_iterator::operator+= ( distance_type delta )

inlinenoexcept

Scalar assignment/addition operator. Increments this iterator by a distance delta from its current position. Positive increments cause this iterator to move forward by delta pixels. Negative increments move this iterator backward by delta pixels. Returns a reference to this iterator.

Definition at line 3898 of file Image.h.

◆ operator--() [1/2]

template<class P >

const_pixel_iterator& pcl::GenericImage::const_pixel_iterator::operator-- ( )

inlinenoexcept

Pre-decrement operator. Causes this iterator to point to the previous pixel in the iterated image. Returns a reference to this iterator.

Definition at line 3871 of file Image.h.

◆ operator--() [2/2]

template<class P >

const_pixel_iterator pcl::GenericImage::const_pixel_iterator::operator-- ( int )

inlinenoexcept

Post-decrement operator. Causes this iterator to point to the previous pixel in the iterated image. Returns a copy of the iterator as it was before decrementing it.

Definition at line 3883 of file Image.h.

◆ operator-=()

template<class P >

const_pixel_iterator& pcl::GenericImage::const_pixel_iterator::operator-= ( distance_type delta )

inlinenoexcept

Scalar assignment/subtraction operator. Decrements this iterator by a distance delta from its current position. Positive increments cause this iterator to move backward by delta pixels. Negative increments move this iterator forward by delta pixels. Returns a reference to this iterator.

Definition at line 3912 of file Image.h.

◆ operator=()

template<class P >

const_pixel_iterator& pcl::GenericImage::const_pixel_iterator::operator= ( const const_pixel_iterator & )

default

Copy assignment operator. Returns a reference to this iterator.

◆ operator[]()

template<class P >

const sample& pcl::GenericImage::const_pixel_iterator::operator[] ( int channel ) const

inlinenoexcept

Array subscript operator. Returns a reference to the constant pixel sample pointed to by this iterator in the specified channel.

Definition at line 3838 of file Image.h.

◆ Position()

template<class P >

const sample* pcl::GenericImage::const_pixel_iterator::Position ( int channel ) const

inlinenoexcept

Returns a pointer to the constant pixel sample pointed to by this iterator in the specified channel.

Definition at line 3819 of file Image.h.

Friends And Related Function Documentation

◆ operator+ [1/2]

template<class P >

const_pixel_iterator operator+	(	const const_pixel_iterator &	i,
		distance_type	delta
	)

friend

Scalar-to-iterator addition operator. Returns an iterator equivalent to the specified iterator i incremented by a distance delta.

Definition at line 3935 of file Image.h.

◆ operator+ [2/2]

template<class P >

const_pixel_iterator operator+	(	distance_type	delta,
		const const_pixel_iterator &	i
	)

friend

Iterator-to-scalar addition operator. This operator implements the commutative property of scalar-to-iterator addition.

Definition at line 3946 of file Image.h.

◆ operator- [1/2]

template<class P >

distance_type operator-	(	const const_pixel_iterator &	i,
		const const_pixel_iterator &	j
	)

friend

Iterator subtraction operator. Returns the distance in pixels between the specified iterators i and j.

Definition at line 3968 of file Image.h.

◆ operator- [2/2]

template<class P >

const_pixel_iterator operator-	(	const const_pixel_iterator &	i,
		distance_type	delta
	)

friend

Scalar-to-iterator subtraction operator. Returns an iterator equal to the specified iterator i decremented by a distance delta.

Definition at line 3957 of file Image.h.

◆ operator<

template<class P >

bool operator<	(	const const_pixel_iterator &	i,
		const const_pixel_iterator &	j
	)

friend

Less than operator. Returns true if the specified iterator i precedes another iterator j.

Definition at line 3986 of file Image.h.

◆ operator==

template<class P >

bool operator==	(	const const_pixel_iterator &	i,
		const const_pixel_iterator &	j
	)

friend

Equality operator. Returns true if two iterators i and j point to the same pixel.

Definition at line 3977 of file Image.h.

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

Image.h

Public Types

Public Member Functions

Friends

Detailed Description

template<class P> class pcl::GenericImage< P >::const_pixel_iterator

Member Typedef Documentation

◆ image_type

◆ pixel_traits

◆ sample

Constructor & Destructor Documentation

◆ const_pixel_iterator() [1/3]

◆ const_pixel_iterator() [2/3]

◆ const_pixel_iterator() [3/3]

Member Function Documentation

◆ Image()

◆ IsValid()

◆ MoveBy()

◆ operator bool()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator=()

◆ operator[]()

◆ Position()

Friends And Related Function Documentation

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator- [1/2]

◆ operator- [2/2]

◆ operator<

◆ operator==

template<class P>
class pcl::GenericImage< P >::const_pixel_iterator