mmcfilters::MorphologicalTree::ProperPartIterator Class Reference

Iterator over the pixels in one node's proper part. More...

#include <MorphologicalTree.hpp>

Public Types
using	iterator_category = std::forward_iterator_tag
	Standard iterator category exposed for STL compatibility.
using	value_type = PixelId
	Proper-part id yielded by the iterator.
using	difference_type = std::ptrdiff_t
	Signed distance type exposed for STL compatibility.
using	pointer = const PixelId *
	Pointer type exposed for STL compatibility.
using	reference = const PixelId &
	Reference type exposed for STL compatibility.

Public Member Functions
	ProperPartIterator ()=default
	Creates the end/sentinel proper-part iterator.
	ProperPartIterator (const MorphologicalTree *tree, PixelId currentProperPart, std::size_t expectedVersion)
	Creates a proper-part iterator starting from a linked-list entry.
ProperPartIterator &	operator++ ()
	Advances to the next pixel in the proper part.
PixelId	operator* () const
	Returns the current pixel identifier.
bool	operator== (const ProperPartIterator &other) const
	Compares proper-part iterator positions.
bool	operator!= (const ProperPartIterator &other) const
	Compares proper-part iterator positions for inequality.

Detailed Description

Iterator over the pixels in one node's proper part.

Definition at line 3342 of file MorphologicalTree.hpp.

Member Typedef Documentation

difference_type

using mmcfilters::MorphologicalTree::ProperPartIterator::difference_type = std::ptrdiff_t

Signed distance type exposed for STL compatibility.

Definition at line 3357 of file MorphologicalTree.hpp.

iterator_category

using mmcfilters::MorphologicalTree::ProperPartIterator::iterator_category = std::forward_iterator_tag

Standard iterator category exposed for STL compatibility.

Definition at line 3353 of file MorphologicalTree.hpp.

pointer

using mmcfilters::MorphologicalTree::ProperPartIterator::pointer = const PixelId*

Pointer type exposed for STL compatibility.

Definition at line 3359 of file MorphologicalTree.hpp.

reference

using mmcfilters::MorphologicalTree::ProperPartIterator::reference = const PixelId&

Reference type exposed for STL compatibility.

Definition at line 3361 of file MorphologicalTree.hpp.

value_type

using mmcfilters::MorphologicalTree::ProperPartIterator::value_type = PixelId

Proper-part id yielded by the iterator.

Definition at line 3355 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

ProperPartIterator()

mmcfilters::MorphologicalTree::ProperPartIterator::ProperPartIterator ( const MorphologicalTree *  tree, PixelId  currentProperPart, std::size_t  expectedVersion  )

inline

Creates a proper-part iterator starting from a linked-list entry.

Parameters

tree	Tree topology.
currentProperPart	Proper-part data.
expectedVersion	Mutation version required by the operation.

Definition at line 3375 of file MorphologicalTree.hpp.

Member Function Documentation

operator!=()

bool mmcfilters::MorphologicalTree::ProperPartIterator::operator!= ( const ProperPartIterator &  other ) const

inline

Compares proper-part iterator positions for inequality.

Parameters

other

Object to compare with or transfer from.

Returns

True when the documented condition holds; otherwise false.

Definition at line 3415 of file MorphologicalTree.hpp.

operator*()

PixelId mmcfilters::MorphologicalTree::ProperPartIterator::operator* ( ) const

inline

Returns the current pixel identifier.

Returns

The current pixel identifier.

Definition at line 3396 of file MorphologicalTree.hpp.

operator++()

ProperPartIterator & mmcfilters::MorphologicalTree::ProperPartIterator::operator++ ( )

inline

Advances to the next pixel in the proper part.

Returns

Mutable reference to the updated object.

Definition at line 3383 of file MorphologicalTree.hpp.

operator==()

bool mmcfilters::MorphologicalTree::ProperPartIterator::operator== ( const ProperPartIterator &  other ) const

inline

Compares proper-part iterator positions.

Parameters

other

Object to compare with or transfer from.

Returns

True when the documented condition holds; otherwise false.

Definition at line 3407 of file MorphologicalTree.hpp.

---

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

• mmcfilters/trees/MorphologicalTree.hpp