ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE > Class Template Reference
Group Core » Module ITKQuadEdgeMesh

#include <itkQuadEdgeMeshFrontIterator.h>

Detailed Description

template<typename TMesh, typename TQE>
class itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >

Front iterator on Mesh class.

Like topological and geometrical operators, it iterates on edges. Unlike them, this iterator is not local, nor cyclic. Starting from a given seed, it will create a front that propagates on the surface. Depending on the weight associated which each edge, and on the type of the seed (primal or dual) it can be used for front propagation algorithm, distance tree computation or other Djikstra like algorithms.

Definition at line 75 of file itkQuadEdgeMeshFrontIterator.h.

+ Inheritance diagram for itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >:
+ Collaboration diagram for itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >:

Classes

class  FrontAtom
 

Public Types

using MeshType = TMesh
 
using QEType = TQE
 
using Self = QuadEdgeMeshFrontBaseIterator
 

Public Member Functions

MeshType * GetMesh () const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
 
Self & operator++ ()
 
Self & operator++ (int)
 
Self & operator= (const Self &r)
 
bool operator== (const Self &r) const
 

Protected Types

using CoordRepType = typename MeshType::CoordRepType
 
using QEOriginType = typename QEType::OriginRefType
 

Protected Member Functions

QEType * FindDefaultSeed ()
 
virtual CoordRepType GetCost (QEType *)
 

Protected Attributes

QEType * m_CurrentEdge {}
 
FrontTypePointer m_Front {}
 
IsVisitedPointerType m_IsPointVisited {}
 
MeshType * m_Mesh {}
 
QEType * m_Seed {}
 
bool m_Start {}
 
using FrontType = std::list< FrontAtom >
 
using FrontTypeIterator = typename FrontType::iterator
 
using FrontTypePointer = FrontType *
 
using IsVisitedContainerType = MapContainer< QEOriginType, bool >
 
using IsVisitedPointerType = typename IsVisitedContainerType::Pointer
 
 QuadEdgeMeshFrontBaseIterator (MeshType *mesh=nullptr, bool start=true, QEType *seed=nullptr)
 
virtual ~QuadEdgeMeshFrontBaseIterator ()
 

Member Typedef Documentation

◆ CoordRepType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::CoordRepType = typename MeshType::CoordRepType
protected

Definition at line 87 of file itkQuadEdgeMeshFrontIterator.h.

◆ FrontType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::FrontType = std::list<FrontAtom>
protected

The active front is simply a list of edges that can be sorted on the sort attribute FrontAtom

Definition at line 138 of file itkQuadEdgeMeshFrontIterator.h.

◆ FrontTypeIterator

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::FrontTypeIterator = typename FrontType::iterator
protected

The active front is simply a list of edges that can be sorted on the sort attribute FrontAtom

Definition at line 139 of file itkQuadEdgeMeshFrontIterator.h.

◆ FrontTypePointer

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::FrontTypePointer = FrontType *
protected

The active front is simply a list of edges that can be sorted on the sort attribute FrontAtom

Definition at line 140 of file itkQuadEdgeMeshFrontIterator.h.

◆ IsVisitedContainerType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::IsVisitedContainerType = MapContainer<QEOriginType, bool>
protected

Whether an Origin (i.e. a vertex or a face since we either deal with primal or dual edges) was already visited.

Definition at line 145 of file itkQuadEdgeMeshFrontIterator.h.

◆ IsVisitedPointerType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::IsVisitedPointerType = typename IsVisitedContainerType::Pointer
protected

The active front is simply a list of edges that can be sorted on the sort attribute FrontAtom

Definition at line 146 of file itkQuadEdgeMeshFrontIterator.h.

◆ MeshType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::MeshType = TMesh

Definition at line 82 of file itkQuadEdgeMeshFrontIterator.h.

◆ QEOriginType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::QEOriginType = typename QEType::OriginRefType
protected

Definition at line 89 of file itkQuadEdgeMeshFrontIterator.h.

◆ QEType

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::QEType = TQE

Definition at line 83 of file itkQuadEdgeMeshFrontIterator.h.

◆ Self

template<typename TMesh , typename TQE >
using itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::Self = QuadEdgeMeshFrontBaseIterator

Definition at line 79 of file itkQuadEdgeMeshFrontIterator.h.

Constructor & Destructor Documentation

◆ QuadEdgeMeshFrontBaseIterator()

template<typename TMesh , typename TQE >
itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::QuadEdgeMeshFrontBaseIterator ( MeshType *  mesh = nullptr,
bool  start = true,
QEType *  seed = nullptr 
)

Object creation methods.

◆ ~QuadEdgeMeshFrontBaseIterator()

template<typename TMesh , typename TQE >
virtual itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::~QuadEdgeMeshFrontBaseIterator ( )
virtual

The active front is simply a list of edges that can be sorted on the sort attribute FrontAtom

Member Function Documentation

◆ FindDefaultSeed()

template<typename TMesh , typename TQE >
QEType* itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::FindDefaultSeed ( )
protected

Find a default seed by taking any edge (with proper type) in the current mesh.

◆ GetCost()

template<typename TMesh , typename TQE >
virtual CoordRepType itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::GetCost ( QEType *  )
inlineprotectedvirtual

The default cost associated to an edge is simply 1. This corresponds to the "topological metric" i.e. all edges have unit length.

Definition at line 204 of file itkQuadEdgeMeshFrontIterator.h.

◆ GetMesh()

template<typename TMesh , typename TQE >
MeshType* itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::GetMesh ( ) const
inline

Definition at line 188 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshConstFrontIterator< TMesh, TQE >::operator=().

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TMesh , typename TQE >
itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( Self  )

◆ operator++() [1/2]

template<typename TMesh , typename TQE >
Self& itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator++ ( )

◆ operator++() [2/2]

template<typename TMesh , typename TQE >
Self& itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator++ ( int  )
inline

Definition at line 182 of file itkQuadEdgeMeshFrontIterator.h.

◆ operator=()

template<typename TMesh , typename TQE >
Self& itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator= ( const Self &  r)
inline

Definition at line 155 of file itkQuadEdgeMeshFrontIterator.h.

References itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_CurrentEdge, itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Front, itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_IsPointVisited, itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Mesh, itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Seed, and itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Start.

◆ operator==()

template<typename TMesh , typename TQE >
bool itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator== ( const Self &  r) const
inline

Definition at line 171 of file itkQuadEdgeMeshFrontIterator.h.

References itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Start.

Member Data Documentation

◆ m_CurrentEdge

template<typename TMesh , typename TQE >
QEType* itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_CurrentEdge {}
protected

The current edge at this stage of iteration

Definition at line 226 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator=().

◆ m_Front

template<typename TMesh , typename TQE >
FrontTypePointer itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Front {}
protected

The active front

Definition at line 220 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator=().

◆ m_IsPointVisited

template<typename TMesh , typename TQE >
IsVisitedPointerType itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_IsPointVisited {}
protected

The already visited points

Definition at line 223 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator=().

◆ m_Mesh

template<typename TMesh , typename TQE >
MeshType* itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Mesh {}
protected

Mesh on which we propagate the front

Definition at line 211 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator=().

◆ m_Seed

template<typename TMesh , typename TQE >
QEType* itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Seed {}
protected

Initial seed of the front

Definition at line 214 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator=().

◆ m_Start

template<typename TMesh , typename TQE >
bool itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::m_Start {}
protected

Whether the iterator is active

Definition at line 217 of file itkQuadEdgeMeshFrontIterator.h.

Referenced by itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator=(), and itk::QuadEdgeMeshFrontBaseIterator< TMesh, TQE >::operator==().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16