Mutable region-of-interest pixel sample iterator. More...

#include <Image.h>

Inherits pcl::GenericImage::roi_sample_iterator_base< image_type, sample_pointer >.

Public Types
using	image_type = GenericImage< P >

using	pixel_traits = typename image_type::pixel_traits

using	sample = typename image_type::sample

Public Member Functions
	roi_sample_iterator ()=default

	roi_sample_iterator (const roi_sample_iterator &)=default

	roi_sample_iterator (image_type &image, const Rect &rect=Rect(0), int channel=-1)

	roi_sample_iterator (image_type &image, sample i, sample j)

image_type &	Image () const noexcept

bool	IsValid () const noexcept

roi_sample_iterator &	MoveBy (int dx, int dy) noexcept

	operator bool () const noexcept

sample &	operator* () const noexcept

roi_sample_iterator &	operator++ () noexcept

roi_sample_iterator	operator++ (int) noexcept

roi_sample_iterator &	operator+= (distance_type delta) noexcept

roi_sample_iterator &	operator-- () noexcept

roi_sample_iterator	operator-- (int) noexcept

roi_sample_iterator &	operator-= (distance_type delta) noexcept

roi_sample_iterator &	operator= (const roi_sample_iterator &)=default

sample *	Position () const noexcept

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

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

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

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

bool	operator< (const roi_sample_iterator &i, const sample *j) noexcept

bool	operator< (const sample *i, const roi_sample_iterator &j) noexcept

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

bool	operator== (const roi_sample_iterator &i, const sample *j) noexcept

bool	operator== (const sample *i, const roi_sample_iterator &j) noexcept

Detailed Description

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

A mutable, region-of-interest (ROI) pixel sample iterator provides read/write, random access to pixel samples within a rectangular subset of a single channel of an image.

Definition at line 1132 of file Image.h.

Member Typedef Documentation

◆ image_type

template<class P >

using pcl::GenericImage::roi_sample_iterator::image_type = GenericImage

Represents the type of the iterated image.

Definition at line 1139 of file Image.h.

◆ pixel_traits

template<class P >

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

Represents the pixel traits class used by the iterated image.

Definition at line 1144 of file Image.h.

◆ sample

template<class P >

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

Represents a pixel sample of the iterated image.

Definition at line 1149 of file Image.h.

Constructor & Destructor Documentation

◆ roi_sample_iterator() [1/4]

template<class P >

pcl::GenericImage::roi_sample_iterator::roi_sample_iterator ( )

default

Default constructor. Initializes an invalid iterator.

◆ roi_sample_iterator() [2/4]

template<class P >

pcl::GenericImage< P >::roi_sample_iterator::roi_sample_iterator	(	image_type &	image,
		const Rect &	rect = `Rect( 0 )`,
		int	channel = `-1`
	)

inline

Constructs a mutable, region-of-interest (ROI) pixel sample iterator for one channel of an image.

Parameters

image	The image to iterate.
rect	Region of interest. If an empty rectangle is specified, the current rectangular selection in the image will be used. If the specified rectangle is not empty and extends beyond image boundaries, only the intersection with the image will be used. If that intersection does not exist, then the resulting iterator will be invalid, with an empty iteration range. The default value is an empty rectangle.
channel	Channel index. If this parameter is a negative integer, then this object will be initialized to iterate on the currently selected channel of the image. If an invalid (i.e., nonexistent) channel index is specified, then the resulting iterator will also be invalid, with an empty iteration range. The default value is -1.

Definition at line 1180 of file Image.h.

◆ roi_sample_iterator() [3/4]

template<class P >

pcl::GenericImage< P >::roi_sample_iterator::roi_sample_iterator	(	image_type &	image,
		sample *	i,
		sample *	j
	)

inline

Constructs a mutable, region-of-interest (ROI) pixel sample iterator for a range of pixel samples of an image.

Parameters

image	The image to iterate.
i	Pointer to the first pixel sample in the iteration range. The iterator will be initialized to access this pixel sample just after construction.
j	End of the iteration range. The iterator will be invalid when it reaches (or surpasses) this point.

Note: Both iteration limits i and j must be pointers to pixel samples in the same channel of the specified image.

Definition at line 1201 of file Image.h.

◆ roi_sample_iterator() [4/4]

template<class P >

pcl::GenericImage::roi_sample_iterator::roi_sample_iterator ( const roi_sample_iterator & )

default

Copy constructor.

Member Function Documentation

◆ Image()

template<class P >

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

inlinenoexcept

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

Definition at line 1228 of file Image.h.

◆ IsValid()

template<class P >

bool pcl::GenericImage::roi_sample_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 1220 of file Image.h.

◆ MoveBy()

template<class P >

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

inlinenoexcept

Moves this iterator within its rectangular region of interest 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 1347 of file Image.h.

◆ operator bool()

template<class P >

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

inlinenoexcept

Boolean type conversion operator. Returns true if this iterator is active. A ROI pixel sample iterator is active if it has not reached (or surpassed) its iteration limit, i.e. the bottom right corner of its iterated region of interest.

Definition at line 1247 of file Image.h.

◆ operator*()

template<class P >

sample& pcl::GenericImage::roi_sample_iterator::operator* ( ) const

inlinenoexcept

Indirection operator. Returns a reference to the pixel sample pointed to by this iterator.

Definition at line 1256 of file Image.h.

◆ operator++() [1/2]

template<class P >

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

inlinenoexcept

Pre-increment operator. Causes this iterator to point to the next pixel sample in the iterated region of interest, then returns a reference to this iterator.

Definition at line 1266 of file Image.h.

◆ operator++() [2/2]

template<class P >

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

inlinenoexcept

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

Definition at line 1277 of file Image.h.

◆ operator+=()

template<class P >

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

inlinenoexcept

Scalar assignment/addition operator. Increments this iterator by a distance delta from its current position, within the rectangular region of interest being iterated. Positive increments cause this iterator to move forward (rightwards and downwards) by delta pixel samples. Negative increments move this iterator backward (leftwards and upwards) by delta pixel samples. Returns a reference to this iterator.

Definition at line 1316 of file Image.h.

◆ operator--() [1/2]

template<class P >

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

inlinenoexcept

Pre-decrement operator. Causes this iterator to point to the previous pixel sample in the iterated region of interest, then returns a reference to this iterator.

Definition at line 1289 of file Image.h.

◆ operator--() [2/2]

template<class P >

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

inlinenoexcept

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

Definition at line 1300 of file Image.h.

◆ operator-=()

template<class P >

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

inlinenoexcept

Scalar assignment/subtraction operator. Decrements this iterator by a distance delta from its current position, within the rectangular region of interest being iterated. Positive increments cause this iterator to move backward (leftwards and upwards) by delta pixel samples. Negative increments move this iterator forward (rightwards and downwards) by delta pixel samples. Returns a reference to this iterator.

Definition at line 1332 of file Image.h.

◆ operator=()

template<class P >

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

default

Copy assignment operator. Returns a reference to this object.

◆ Position()

template<class P >

sample* pcl::GenericImage::roi_sample_iterator::Position ( ) const

inlinenoexcept

Returns a pointer to the pixel sample pointed to by this iterator.

Definition at line 1236 of file Image.h.

Friends And Related Function Documentation

◆ operator+ [1/2]

template<class P >

roi_sample_iterator operator+	(	const roi_sample_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 1357 of file Image.h.

◆ operator+ [2/2]

template<class P >

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

friend

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

Definition at line 1368 of file Image.h.

◆ operator-

template<class P >

roi_sample_iterator operator-	(	const roi_sample_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 1379 of file Image.h.

◆ operator< [1/3]

template<class P >

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

friend

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

Definition at line 1417 of file Image.h.

◆ operator< [2/3]

template<class P >

bool operator<	(	const roi_sample_iterator &	i,
		const sample *	j
	)

friend

Returns true iff an iterator i precedes a sample pointer j.

Definition at line 1425 of file Image.h.

◆ operator< [3/3]

template<class P >

bool operator<	(	const sample *	i,
		const roi_sample_iterator &	j
	)

friend

Returns true iff a sample pointer i precedes an iterator j.

Definition at line 1433 of file Image.h.

◆ operator== [1/3]

template<class P >

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

friend

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

Definition at line 1390 of file Image.h.

◆ operator== [2/3]

template<class P >

bool operator==	(	const roi_sample_iterator &	i,
		const sample *	j
	)

friend

Returns true iff an iterator i and a sample pointer j point to the same pixel sample.

Definition at line 1399 of file Image.h.

◆ operator== [3/3]

template<class P >

bool operator==	(	const sample *	i,
		const roi_sample_iterator &	j
	)

friend

Returns true iff a sample pointer i and an iterator j point to the same pixel sample.

Definition at line 1408 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 >::roi_sample_iterator

Member Typedef Documentation

◆ image_type

◆ pixel_traits

◆ sample

Constructor & Destructor Documentation

◆ roi_sample_iterator() [1/4]

◆ roi_sample_iterator() [2/4]

◆ roi_sample_iterator() [3/4]

◆ roi_sample_iterator() [4/4]

Member Function Documentation

◆ Image()

◆ IsValid()

◆ MoveBy()

◆ operator bool()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator=()

◆ Position()

Friends And Related Function Documentation

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator-

◆ operator< [1/3]

◆ operator< [2/3]

◆ operator< [3/3]

◆ operator== [1/3]

◆ operator== [2/3]

◆ operator== [3/3]

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