ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::LevelSetNeighborhoodExtractor< TLevelSet > Class Template Reference
Data Processing Objects » Filters » Image Filters » Image Segmentation Filters » Model-Based Image Segmentation Filters » Level Set-Based Segmentation Filters | Group Segmentation » Module ITKLevelSets

#include <itkLevelSetNeighborhoodExtractor.h>

Detailed Description

template<typename TLevelSet>
class itk::LevelSetNeighborhoodExtractor< TLevelSet >

Locate pixels of a particular level set.

LevelSetNeighborhoodExtractor locates a particular level set in the input level set. Specifically, the method Locate() fills two containers: one containing pixels immediately inside the contour defined by the level set and the other containing pixels immediately outside. For each located pixel, an estimated distance to the particular level set is also calculated.

The containers InsidePoints and OutsidePoints can then be used in FastMarchingImageFilter to produce a signed distance map from the specified level set.

This class is templated over the image type representing the level set.

This class supports narrowbanding. If a input narrowband is provided, the algorithm will only search pixels within the narrowband.

Implementation of this class is based on Chapter 11 of "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Second edition, 1999.

Definition at line 57 of file itkLevelSetNeighborhoodExtractor.h.

+ Inheritance diagram for itk::LevelSetNeighborhoodExtractor< TLevelSet >:
+ Collaboration diagram for itk::LevelSetNeighborhoodExtractor< TLevelSet >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = Index< Self::SetDimension >
 
using LevelSetConstPointer = typename LevelSetType::LevelSetConstPointer
 
using LevelSetImageType = typename LevelSetType::LevelSetImageType
 
using LevelSetPointer = typename LevelSetType::LevelSetPointer
 
using LevelSetType = LevelSetTypeDefault< TLevelSet >
 
using NodeContainer = typename LevelSetType::NodeContainer
 
using NodeContainerPointer = typename LevelSetType::NodeContainerPointer
 
using NodeType = typename LevelSetType::NodeType
 
using PixelType = typename LevelSetType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = LevelSetNeighborhoodExtractor
 
using Superclass = LightProcessObject
 
- Public Types inherited from itk::LightProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

NodeContainerPointer GetInsidePoints ()
 
virtual double GetLevelSetValue () const
 
const char * GetNameOfClass () const override
 
virtual double GetNarrowBandwidth () const
 
NodeContainerPointer GetOutsidePoints ()
 
void Locate ()
 
virtual void SetLevelSetValue (double _arg)
 
virtual void SetNarrowBanding (bool _arg)
 
virtual void SetNarrowBandwidth (double _arg)
 
virtual void SetInputLevelSet (const LevelSetImageType *_arg)
 
virtual const LevelSetImageType * GetInputLevelSet () const
 
virtual bool GetNarrowBanding () const
 
virtual void NarrowBandingOn ()
 
void SetInputNarrowBand (NodeContainer *ptr)
 
virtual NodeContainer * GetModifiableInputNarrowBand ()
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
const char * GetNameOfClass () const override
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LightProcessObject
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int SetDimension = LevelSetType::SetDimension
 

Protected Member Functions

virtual double CalculateDistance (IndexType &index)
 
void GenerateData () override
 
LevelSetImageType::PixelType GetLargeValue () const
 
bool GetLastPointIsInside () const
 
const NodeType & GetNodeUsedInCalculation (unsigned int idx) const
 
virtual void Initialize ()
 
 LevelSetNeighborhoodExtractor ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LevelSetNeighborhoodExtractor () override=default
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void GenerateDataFull ()
 
void GenerateDataNarrowBand ()
 

Private Attributes

LevelSetImageType::RegionType m_ImageRegion {}
 
LevelSetConstPointer m_InputLevelSet {}
 
NodeContainerPointer m_InputNarrowBand {}
 
NodeContainerPointer m_InsidePoints {}
 
LevelSetImageType::PixelType m_LargeValue {}
 
bool m_LastPointIsInside { false }
 
double m_LevelSetValue { 0.0 }
 
bool m_NarrowBanding { false }
 
double m_NarrowBandwidth { 12.0 }
 
std::vector< NodeType > m_NodesUsed {}
 
NodeContainerPointer m_OutsidePoints {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::ConstPointer = SmartPointer<const Self>

Definition at line 66 of file itkLevelSetNeighborhoodExtractor.h.

◆ IndexType

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::IndexType = Index<Self::SetDimension>

Index type alias support

Definition at line 88 of file itkLevelSetNeighborhoodExtractor.h.

◆ LevelSetConstPointer

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetConstPointer = typename LevelSetType::LevelSetConstPointer

Definition at line 78 of file itkLevelSetNeighborhoodExtractor.h.

◆ LevelSetImageType

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetImageType = typename LevelSetType::LevelSetImageType

Definition at line 76 of file itkLevelSetNeighborhoodExtractor.h.

◆ LevelSetPointer

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetPointer = typename LevelSetType::LevelSetPointer

Definition at line 77 of file itkLevelSetNeighborhoodExtractor.h.

◆ LevelSetType

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetType = LevelSetTypeDefault<TLevelSet>

LevelSetType type alias support

Definition at line 75 of file itkLevelSetNeighborhoodExtractor.h.

◆ NodeContainer

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::NodeContainer = typename LevelSetType::NodeContainer

Definition at line 81 of file itkLevelSetNeighborhoodExtractor.h.

◆ NodeContainerPointer

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::NodeContainerPointer = typename LevelSetType::NodeContainerPointer

Definition at line 82 of file itkLevelSetNeighborhoodExtractor.h.

◆ NodeType

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::NodeType = typename LevelSetType::NodeType

Definition at line 80 of file itkLevelSetNeighborhoodExtractor.h.

◆ PixelType

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::PixelType = typename LevelSetType::PixelType

Definition at line 79 of file itkLevelSetNeighborhoodExtractor.h.

◆ Pointer

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::Pointer = SmartPointer<Self>

Definition at line 65 of file itkLevelSetNeighborhoodExtractor.h.

◆ Self

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::Self = LevelSetNeighborhoodExtractor

Standard class typedefs.

Definition at line 63 of file itkLevelSetNeighborhoodExtractor.h.

◆ Superclass

template<typename TLevelSet >
using itk::LevelSetNeighborhoodExtractor< TLevelSet >::Superclass = LightProcessObject

Definition at line 64 of file itkLevelSetNeighborhoodExtractor.h.

Constructor & Destructor Documentation

◆ LevelSetNeighborhoodExtractor()

template<typename TLevelSet >
itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetNeighborhoodExtractor ( )
protected

◆ ~LevelSetNeighborhoodExtractor()

template<typename TLevelSet >
itk::LevelSetNeighborhoodExtractor< TLevelSet >::~LevelSetNeighborhoodExtractor ( )
overrideprotecteddefault

Member Function Documentation

◆ CalculateDistance()

template<typename TLevelSet >
virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::CalculateDistance ( IndexType &  index)
protectedvirtual

Reimplemented in itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >.

◆ GenerateData()

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::LightProcessObject.

◆ GenerateDataFull()

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateDataFull ( )
private

◆ GenerateDataNarrowBand()

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateDataNarrowBand ( )
private

◆ GetInputLevelSet()

template<typename TLevelSet >
virtual const LevelSetImageType * itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetInputLevelSet ( ) const
virtual

Get/Set the input level set.

◆ GetInsidePoints()

template<typename TLevelSet >
NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetInsidePoints ( )
inline

Get the container of inside points. The inside points are stored in a VectorContainer of LevelSetNodes.

Definition at line 125 of file itkLevelSetNeighborhoodExtractor.h.

◆ GetLargeValue()

template<typename TLevelSet >
LevelSetImageType::PixelType itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLargeValue ( ) const
inlineprotected

Definition at line 150 of file itkLevelSetNeighborhoodExtractor.h.

◆ GetLastPointIsInside()

template<typename TLevelSet >
bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLastPointIsInside ( ) const
inlineprotected

Definition at line 171 of file itkLevelSetNeighborhoodExtractor.h.

◆ GetLevelSetValue()

template<typename TLevelSet >
virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLevelSetValue ( ) const
virtual

Get the value of the level set to be located.

◆ GetModifiableInputNarrowBand()

template<typename TLevelSet >
virtual NodeContainer * itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetModifiableInputNarrowBand ( )
virtual

Set/Get the input narrowband. A narrowband is represented as a VectorContainer of LevelSetNodes.

◆ GetNameOfClass()

template<typename TLevelSet >
const char * itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >.

◆ GetNarrowBanding()

template<typename TLevelSet >
virtual bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNarrowBanding ( ) const
virtual

Get the narrowbanding flag.

◆ GetNarrowBandwidth()

template<typename TLevelSet >
virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNarrowBandwidth ( ) const
virtual

Get the narrow band width.

◆ GetNodeUsedInCalculation()

template<typename TLevelSet >
const NodeType & itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNodeUsedInCalculation ( unsigned int  idx) const
inlineprotected

Definition at line 156 of file itkLevelSetNeighborhoodExtractor.h.

◆ GetOutsidePoints()

template<typename TLevelSet >
NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetOutsidePoints ( )
inline

Get the container of outside points. The outside points are stored in a VectorContainer of LevelSetNodes.

Definition at line 133 of file itkLevelSetNeighborhoodExtractor.h.

◆ Initialize()

template<typename TLevelSet >
virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::Initialize ( )
protectedvirtual

Reimplemented in itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >.

◆ Locate()

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::Locate ( )

Locate the level set. This method evokes the level set location algorithm.

◆ NarrowBandingOn()

template<typename TLevelSet >
virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::NarrowBandingOn ( )
virtual

Get the narrowbanding flag.

◆ New()

template<typename TLevelSet >
static Pointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >.

◆ SetInputLevelSet()

template<typename TLevelSet >
virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetInputLevelSet ( const LevelSetImageType *  _arg)
virtual

Get/Set the input level set.

◆ SetInputNarrowBand()

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetInputNarrowBand ( NodeContainer *  ptr)

Set/Get the input narrowband. A narrowband is represented as a VectorContainer of LevelSetNodes.

◆ SetLevelSetValue()

template<typename TLevelSet >
virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetLevelSetValue ( double  _arg)
virtual

Set the value of the level set to be located. Default is 0.

◆ SetNarrowBanding()

template<typename TLevelSet >
virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetNarrowBanding ( bool  _arg)
virtual

Set the narrowbanding flag.

◆ SetNarrowBandwidth()

template<typename TLevelSet >
virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetNarrowBandwidth ( double  _arg)
virtual

Set the narrow band width. Default is 12.

Member Data Documentation

◆ m_ImageRegion

template<typename TLevelSet >
LevelSetImageType::RegionType itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_ImageRegion {}
private

Definition at line 194 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_InputLevelSet

template<typename TLevelSet >
LevelSetConstPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_InputLevelSet {}
private

Definition at line 188 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_InputNarrowBand

template<typename TLevelSet >
NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_InputNarrowBand {}
private

Definition at line 192 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_InsidePoints

template<typename TLevelSet >
NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_InsidePoints {}
private

Definition at line 185 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_LargeValue

template<typename TLevelSet >
LevelSetImageType::PixelType itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_LargeValue {}
private

Definition at line 195 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_LastPointIsInside

template<typename TLevelSet >
bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_LastPointIsInside { false }
private

Definition at line 199 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_LevelSetValue

template<typename TLevelSet >
double itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_LevelSetValue { 0.0 }
private

Definition at line 183 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_NarrowBanding

template<typename TLevelSet >
bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_NarrowBanding { false }
private

Definition at line 190 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_NarrowBandwidth

template<typename TLevelSet >
double itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_NarrowBandwidth { 12.0 }
private

Definition at line 191 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_NodesUsed

template<typename TLevelSet >
std::vector<NodeType> itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_NodesUsed {}
private

Definition at line 197 of file itkLevelSetNeighborhoodExtractor.h.

◆ m_OutsidePoints

template<typename TLevelSet >
NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_OutsidePoints {}
private

Definition at line 186 of file itkLevelSetNeighborhoodExtractor.h.

◆ SetDimension

template<typename TLevelSet >
constexpr unsigned int itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetDimension = LevelSetType::SetDimension
staticconstexpr

SetDimension enumeration.

Definition at line 85 of file itkLevelSetNeighborhoodExtractor.h.

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.9.3