PCL
pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F > Class Template Reference

Immutable region-of-interest, filter pixel iterator. More...

#include <Image.h>

Inherits pcl::GenericImage< P >::roi_filter_pixel_iterator_base< image_type, sample_pointer, filter_type >.

Public Types

using filter_type = F
 
using image_type = GenericImage< P >
 
using pixel_traits = typename image_type::pixel_traits
 
using sample = typename image_type::sample
 

Public Member Functions

 const_roi_filter_pixel_iterator ()=default
 
 const_roi_filter_pixel_iterator (const const_roi_filter_pixel_iterator &)=default
 
 const_roi_filter_pixel_iterator (const const_roi_pixel_iterator &i, const F &filter)
 
 const_roi_filter_pixel_iterator (const image_type &image, const F &filter, const Rect &rect=Rect(0))
 
const filter_typeFilter () const noexcept
 
filter_typeFilter () noexcept
 
const image_typeImage () const noexcept
 
bool IsValid () const noexcept
 
const_roi_filter_pixel_iteratorMoveBy (int dx, int dy) noexcept
 
 operator bool () const noexcept
 
const_roi_filter_pixel_iteratoroperator++ () noexcept
 
const_roi_filter_pixel_iterator operator++ (int) noexcept
 
const_roi_filter_pixel_iteratoroperator+= (distance_type delta) noexcept
 
const_roi_filter_pixel_iteratoroperator-- () noexcept
 
const_roi_filter_pixel_iterator operator-- (int) noexcept
 
const_roi_filter_pixel_iteratoroperator-= (distance_type delta) noexcept
 
const_roi_filter_pixel_iteratoroperator= (const const_roi_filter_pixel_iterator &)=default
 
const_roi_filter_pixel_iteratoroperator= (const const_roi_pixel_iterator &i) noexcept
 
const sampleoperator[] (int channel) const noexcept
 
const samplePosition (int channel) const noexcept
 

Friends

const_roi_filter_pixel_iterator operator+ (const const_roi_filter_pixel_iterator &i, distance_type delta) noexcept
 
const_roi_filter_pixel_iterator operator+ (distance_type delta, const const_roi_filter_pixel_iterator &i) noexcept
 
const_roi_filter_pixel_iterator operator- (const const_roi_filter_pixel_iterator &i, distance_type delta) noexcept
 
bool operator< (const const_roi_filter_pixel_iterator &i, const const_roi_filter_pixel_iterator &j) noexcept
 
bool operator== (const const_roi_filter_pixel_iterator &i, const const_roi_filter_pixel_iterator &j) noexcept
 

Detailed Description

template<class P>
template<class F>
class pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >

An immutable, region-of-interest (ROI), filter pixel iterator combines the capabilities of const_roi_pixel_iterator and const_filter_pixel_iterator in a single iterator class.

Definition at line 5691 of file Image.h.

Member Typedef Documentation

◆ filter_type

template<class P >
template<class F >
using pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::filter_type = F

Represents the type of the unary predicate used by this filter iterator.

Definition at line 5714 of file Image.h.

◆ image_type

template<class P >
template<class F >
using pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::image_type = GenericImage<P>

Represents the type of the iterated image.

Definition at line 5698 of file Image.h.

◆ pixel_traits

template<class P >
template<class F >
using pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::pixel_traits = typename image_type::pixel_traits

Represents the pixel traits class used by the iterated image.

Definition at line 5703 of file Image.h.

◆ sample

template<class P >
template<class F >
using pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::sample = typename image_type::sample

Represents a pixel sample of the iterated image.

Definition at line 5708 of file Image.h.

Constructor & Destructor Documentation

◆ const_roi_filter_pixel_iterator() [1/4]

template<class P >
template<class F >
pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::const_roi_filter_pixel_iterator ( )
default

Default constructor. Initializes an invalid iterator.

◆ const_roi_filter_pixel_iterator() [2/4]

template<class P >
template<class F >
pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::const_roi_filter_pixel_iterator ( const image_type image,
const F &  filter,
const Rect rect = Rect( 0 ) 
)
inline

Constructs an immutable, region-of-interest (ROI), filter pixel iterator.

Parameters
imageThe constant image to iterate.
filterReference to a predicate object that will be used to filter pixel sample values.
rectRegion 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.

Definition at line 5741 of file Image.h.

◆ const_roi_filter_pixel_iterator() [3/4]

template<class P >
template<class F >
pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::const_roi_filter_pixel_iterator ( const const_roi_pixel_iterator i,
const F &  filter 
)
inline

Constructs an immutable, region-of-interest (ROI), filter pixel iterator from the specified ROI pixel iterator i and filter.

Definition at line 5750 of file Image.h.

◆ const_roi_filter_pixel_iterator() [4/4]

template<class P >
template<class F >
pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::const_roi_filter_pixel_iterator ( const const_roi_filter_pixel_iterator< F > &  )
default

Copy constructor.

Member Function Documentation

◆ Filter() [1/2]

template<class P >
template<class F >
const filter_type& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::Filter ( ) const
inlinenoexcept

Returns a reference to the immutable predicate object used by this filter iterator.

Definition at line 5797 of file Image.h.

◆ Filter() [2/2]

template<class P >
template<class F >
filter_type& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::Filter ( )
inlinenoexcept

Returns a reference to the mutable predicate object used by this filter iterator.

Definition at line 5806 of file Image.h.

◆ Image()

template<class P >
template<class F >
const image_type& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::Image ( ) const
inlinenoexcept

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

Definition at line 5788 of file Image.h.

◆ IsValid()

template<class P >
template<class F >
bool pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::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 5779 of file Image.h.

◆ MoveBy()

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::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 5928 of file Image.h.

◆ operator bool()

template<class P >
template<class F >
pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator bool ( ) const
inlinenoexcept

Boolean type conversion operator. Returns true if this iterator is active. A ROI pixel 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 5826 of file Image.h.

◆ operator++() [1/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator++ ( )
inlinenoexcept

Pre-increment operator. Causes this iterator to point to the next valid pixel in the iterated region of interest. Returns a reference to this iterator.

Definition at line 5845 of file Image.h.

◆ operator++() [2/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator++ ( int  )
inlinenoexcept

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

Definition at line 5857 of file Image.h.

◆ operator+=()

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::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 5899 of file Image.h.

◆ operator--() [1/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator-- ( )
inlinenoexcept

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

Definition at line 5870 of file Image.h.

◆ operator--() [2/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator-- ( int  )
inlinenoexcept

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

Definition at line 5882 of file Image.h.

◆ operator-=()

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::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 5914 of file Image.h.

◆ operator=() [1/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator= ( const const_roi_filter_pixel_iterator< F > &  )
default

Copy assignment operator. Returns a reference to this object.

◆ operator=() [2/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::operator= ( const const_roi_pixel_iterator i)
inlinenoexcept

Assigns a ROI pixel iterator. Returns a reference to this object.

Definition at line 5769 of file Image.h.

◆ operator[]()

template<class P >
template<class F >
const sample& pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::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 5835 of file Image.h.

◆ Position()

template<class P >
template<class F >
const sample* pcl::GenericImage< P >::const_roi_filter_pixel_iterator< F >::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 5815 of file Image.h.

Friends And Related Function Documentation

◆ operator+ [1/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator operator+ ( const const_roi_filter_pixel_iterator< F > &  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 5943 of file Image.h.

◆ operator+ [2/2]

template<class P >
template<class F >
const_roi_filter_pixel_iterator operator+ ( distance_type  delta,
const const_roi_filter_pixel_iterator< F > &  i 
)
friend

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

Definition at line 5954 of file Image.h.

◆ operator-

template<class P >
template<class F >
const_roi_filter_pixel_iterator operator- ( const const_roi_filter_pixel_iterator< F > &  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 5965 of file Image.h.

◆ operator<

template<class P >
template<class F >
bool operator< ( const const_roi_filter_pixel_iterator< F > &  i,
const const_roi_filter_pixel_iterator< F > &  j 
)
friend

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

Definition at line 5985 of file Image.h.

◆ operator==

template<class P >
template<class F >
bool operator== ( const const_roi_filter_pixel_iterator< F > &  i,
const const_roi_filter_pixel_iterator< F > &  j 
)
friend

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

Definition at line 5976 of file Image.h.


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