ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members

#include <itkLevelSetNode.h>

Detailed Description

template<typename TPixel, unsigned int VSetDimension = 2>
class itk::LevelSetNode< TPixel, VSetDimension >

Represent a node in a level set.

LevelSetNode is a simple templated class that represents a node or grid position of a level set. A group or collection of LevelSetNode can then be used to represents a narrowband or region of interest.

LevelSetNode is templated over the data type and dimension of the level set.

Definition at line 45 of file itkLevelSetNode.h.

+ Collaboration diagram for itk::LevelSetNode< TPixel, VSetDimension >:

Public Types

using IndexType = Index< VSetDimension >
 
using PixelType = TPixel
 
using Self = LevelSetNode
 

Public Member Functions

 LevelSetNode (const Self &node)
 
bool operator< (const Self &node) const
 
bool operator<= (const Self &node) const
 
bool operator> (const Self &node) const
 
bool operator>= (const Self &node) const
 
Selfoperator= (const Self &rhs)
 
PixelTypeGetValue ()
 
const PixelTypeGetValue () const
 
void SetValue (const PixelType &input)
 
IndexTypeGetIndex ()
 
const IndexTypeGetIndex () const
 
void SetIndex (const IndexType &input)
 
 LevelSetNode ()
 

Static Public Attributes

static constexpr unsigned int SetDimension = VSetDimension
 

Private Attributes

IndexType m_Index
 
PixelType m_Value
 

Member Typedef Documentation

◆ IndexType

template<typename TPixel , unsigned int VSetDimension = 2>
using itk::LevelSetNode< TPixel, VSetDimension >::IndexType = Index<VSetDimension>

Index type alias.

Definition at line 59 of file itkLevelSetNode.h.

◆ PixelType

template<typename TPixel , unsigned int VSetDimension = 2>
using itk::LevelSetNode< TPixel, VSetDimension >::PixelType = TPixel

Pixel type alias.

Definition at line 53 of file itkLevelSetNode.h.

◆ Self

template<typename TPixel , unsigned int VSetDimension = 2>
using itk::LevelSetNode< TPixel, VSetDimension >::Self = LevelSetNode

Standard class type aliases.

Definition at line 50 of file itkLevelSetNode.h.

Constructor & Destructor Documentation

◆ LevelSetNode() [1/2]

template<typename TPixel , unsigned int VSetDimension = 2>
itk::LevelSetNode< TPixel, VSetDimension >::LevelSetNode ( )
inline

Default constructor

Definition at line 140 of file itkLevelSetNode.h.

References itk::Index< VDimension >::Fill(), and itk::LevelSetNode< TPixel, VSetDimension >::m_Index.

◆ LevelSetNode() [2/2]

template<typename TPixel , unsigned int VSetDimension = 2>
itk::LevelSetNode< TPixel, VSetDimension >::LevelSetNode ( const Self node)
inline

Copy constructor

Definition at line 148 of file itkLevelSetNode.h.

Member Function Documentation

◆ GetIndex() [1/2]

template<typename TPixel , unsigned int VSetDimension = 2>
IndexType & itk::LevelSetNode< TPixel, VSetDimension >::GetIndex ( )
inline

Get/Set index.

Definition at line 123 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Index.

◆ GetIndex() [2/2]

template<typename TPixel , unsigned int VSetDimension = 2>
const IndexType & itk::LevelSetNode< TPixel, VSetDimension >::GetIndex ( ) const
inline

Get/Set index.

Definition at line 128 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Index.

◆ GetValue() [1/2]

template<typename TPixel , unsigned int VSetDimension = 2>
PixelType & itk::LevelSetNode< TPixel, VSetDimension >::GetValue ( )
inline

Get/Set level set value.

Definition at line 105 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ GetValue() [2/2]

template<typename TPixel , unsigned int VSetDimension = 2>
const PixelType & itk::LevelSetNode< TPixel, VSetDimension >::GetValue ( ) const
inline

Get/Set level set value.

Definition at line 110 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ operator<()

template<typename TPixel , unsigned int VSetDimension = 2>
bool itk::LevelSetNode< TPixel, VSetDimension >::operator< ( const Self node) const
inline

Operator <. A LevelSetNode is sorted by its value field.

Definition at line 69 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ operator<=()

template<typename TPixel , unsigned int VSetDimension = 2>
bool itk::LevelSetNode< TPixel, VSetDimension >::operator<= ( const Self node) const
inline

Operator <=. A LevelSetNode is sorted by its value field.

Definition at line 76 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ operator=()

template<typename TPixel , unsigned int VSetDimension = 2>
Self & itk::LevelSetNode< TPixel, VSetDimension >::operator= ( const Self rhs)
inline

Operator =. Two nodes are equal if both their value and index fields are the same.

Definition at line 92 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Index, and itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ operator>()

template<typename TPixel , unsigned int VSetDimension = 2>
bool itk::LevelSetNode< TPixel, VSetDimension >::operator> ( const Self node) const
inline

Operator >. A LevelSetNode is sorted by its value field.

Definition at line 63 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ operator>=()

template<typename TPixel , unsigned int VSetDimension = 2>
bool itk::LevelSetNode< TPixel, VSetDimension >::operator>= ( const Self node) const
inline

Operator >=. A LevelSetNode is sorted by its value field.

Definition at line 84 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

◆ SetIndex()

template<typename TPixel , unsigned int VSetDimension = 2>
void itk::LevelSetNode< TPixel, VSetDimension >::SetIndex ( const IndexType input)
inline

Get/Set index.

Definition at line 133 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Index.

◆ SetValue()

template<typename TPixel , unsigned int VSetDimension = 2>
void itk::LevelSetNode< TPixel, VSetDimension >::SetValue ( const PixelType input)
inline

Get/Set level set value.

Definition at line 115 of file itkLevelSetNode.h.

References itk::LevelSetNode< TPixel, VSetDimension >::m_Value.

Member Data Documentation

◆ m_Index

template<typename TPixel , unsigned int VSetDimension = 2>
IndexType itk::LevelSetNode< TPixel, VSetDimension >::m_Index
private

◆ m_Value

template<typename TPixel , unsigned int VSetDimension = 2>
PixelType itk::LevelSetNode< TPixel, VSetDimension >::m_Value
private

◆ SetDimension

template<typename TPixel , unsigned int VSetDimension = 2>
constexpr unsigned int itk::LevelSetNode< TPixel, VSetDimension >::SetDimension = VSetDimension
staticconstexpr

Level set dimension.

Definition at line 56 of file itkLevelSetNode.h.


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