Mutable pixel sample iterator.
More...
#include <Image.h>
Inherited by pcl::GenericImage< P >::filter_sample_iterator_base< GenericImage< P >, sample_iterator, sample *, F >.
|
| sample_iterator | operator+ (const sample_iterator &i, distance_type delta) noexcept |
| |
| sample_iterator | operator+ (distance_type delta, const sample_iterator &i) noexcept |
| |
| distance_type | operator- (const sample *i, const sample_iterator &j) noexcept |
| |
| distance_type | operator- (const sample_iterator &i, const sample *j) noexcept |
| |
| distance_type | operator- (const sample_iterator &i, const sample_iterator &j) noexcept |
| |
| sample_iterator | operator- (const sample_iterator &i, distance_type delta) noexcept |
| |
| bool | operator< (const sample *i, const sample_iterator &j) noexcept |
| |
| bool | operator< (const sample_iterator &i, const sample *j) noexcept |
| |
| bool | operator< (const sample_iterator &i, const sample_iterator &j) noexcept |
| |
| bool | operator== (const sample *i, const sample_iterator &j) noexcept |
| |
| bool | operator== (const sample_iterator &i, const sample *j) noexcept |
| |
| bool | operator== (const sample_iterator &i, const sample_iterator &j) noexcept |
| |
template<class P>
class pcl::GenericImage< P >::sample_iterator
A mutable pixel sample iterator provides read/write, random access to pixel samples in a single channel of an image.
Definition at line 354 of file Image.h.
◆ image_type
Represents the type of the iterated image.
Definition at line 361 of file Image.h.
◆ pixel_traits
Represents the pixel traits class used by the iterated image.
Definition at line 366 of file Image.h.
◆ sample
Represents a pixel sample of the iterated image.
Definition at line 371 of file Image.h.
◆ sample_iterator() [1/4]
Default constructor. Initializes an invalid iterator.
◆ sample_iterator() [2/4]
Constructs a mutable pixel sample iterator for one channel of an image.
- Parameters
-
| image | The image to iterate. |
| 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 391 of file Image.h.
◆ sample_iterator() [3/4]
Constructs a mutable pixel sample iterator for a range of contiguous 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 418 of file Image.h.
◆ sample_iterator() [4/4]
◆ Image()
Returns a reference to the image being iterated by this object.
Definition at line 447 of file Image.h.
◆ IsValid()
Returns true only if this iterator is valid. A valid iterator defines a valid iterated image and a non-null position.
Definition at line 439 of file Image.h.
◆ MoveBy()
Moves this iterator on the iterated image channel 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 556 of file Image.h.
◆ operator bool()
Boolean type conversion operator. Returns true if this iterator is active. A pixel sample iterator is active if it has not reached (or surpassed) its iteration limit: either the end of the iterated image channel, or the end of the iteration range, depending on how the iterator has been constructed.
Definition at line 467 of file Image.h.
◆ operator*()
Indirection operator. Returns a reference to the pixel sample pointed to by this iterator.
Definition at line 476 of file Image.h.
◆ operator++() [1/2]
Pre-increment operator. Causes this iterator to point to the next pixel sample in the iterated image channel. Returns a reference to this iterator.
Definition at line 486 of file Image.h.
◆ operator++() [2/2]
Post-increment operator. Causes this iterator to point to the next pixel sample in the iterated image channel. Returns a copy of the iterator as it was before incrementing it.
Definition at line 497 of file Image.h.
◆ operator+=()
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 pixel samples. Negative increments move this iterator backward by delta pixel samples. Returns a reference to this iterator.
Definition at line 530 of file Image.h.
◆ operator--() [1/2]
Pre-decrement operator. Causes this iterator to point to the previous pixel sample in the iterated image channel, then returns a reference to this iterator.
Definition at line 507 of file Image.h.
◆ operator--() [2/2]
Post-decrement operator. Causes this iterator to point to the previous pixel sample in the iterated image channel. Returns a copy of the iterator as it was before decrementing it.
Definition at line 518 of file Image.h.
◆ operator-=()
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 pixel samples. Negative increments move this iterator forward by delta pixel samples. Returns a reference to this iterator.
Definition at line 543 of file Image.h.
◆ operator=()
Copy assignment operator. Returns a reference to this object.
◆ Position()
Returns a pointer to the pixel sample pointed to by this iterator.
Definition at line 455 of file Image.h.
◆ operator+ [1/2]
Scalar-to-iterator addition operator. Returns an iterator equivalent to the specified iterator i incremented by a distance delta.
Definition at line 566 of file Image.h.
◆ operator+ [2/2]
Iterator-to-scalar addition operator. This operator implements the commutative property of scalar-to-iterator addition.
Definition at line 575 of file Image.h.
◆ operator- [1/4]
Returns the distance in pixels between a sample pointer i and an iterator j.
Definition at line 611 of file Image.h.
◆ operator- [2/4]
Returns the distance in pixels between an iterator i and a sample pointer j.
Definition at line 602 of file Image.h.
◆ operator- [3/4]
Iterator subtraction operator. Returns the distance in pixels between the specified iterators i and j.
Definition at line 593 of file Image.h.
◆ operator- [4/4]
Scalar-to-iterator subtraction operator. Returns an iterator equal to the specified iterator i decremented by a distance delta.
Definition at line 584 of file Image.h.
◆ operator< [1/3]
Returns true iff a sample pointer i precedes an iterator j.
Definition at line 663 of file Image.h.
◆ operator< [2/3]
Returns true iff an iterator i precedes a sample pointer j.
Definition at line 655 of file Image.h.
◆ operator< [3/3]
Less than operator. Returns true if the specified iterator i precedes another iterator j.
Definition at line 647 of file Image.h.
◆ operator== [1/3]
Returns true iff a sample pointer i and an iterator j point to the same pixel sample.
Definition at line 638 of file Image.h.
◆ operator== [2/3]
Returns true iff an iterator i and a sample pointer j point to the same pixel sample.
Definition at line 629 of file Image.h.
◆ operator== [3/3]
Equality operator. Returns true if two iterators i and j point to the same pixel sample.
Definition at line 620 of file Image.h.
The documentation for this class was generated from the following file:
1.9.1