ITK  5.0.0
Insight Segmentation and Registration 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

#include <itkLevelSetNeighborhoodExtractor.h>

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

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

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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
NodeContainerPointer GetInsidePoints ()
 
virtual double GetLevelSetValue () const
 
virtual const char * GetNameOfClass () const
 
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 LevelSetImageTypeGetInputLevelSet () const
 
virtual bool GetNarrowBanding () const
 
virtual void NarrowBandingOn ()
 
virtual void NarrowBandingOff ()
 
void SetInputNarrowBand (NodeContainer *ptr)
 
virtual NodeContainerGetModifiableInputNarrowBand ()
 
virtual const NodeContainerGetInputNarrowBand () const
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
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 *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

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 flag)
 
- 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 NodeTypeGetNodeUsedInCalculation (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
 LightProcessObject ()
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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 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< NodeTypem_NodesUsed
 
NodeContainerPointer m_OutsidePoints
 

Additional Inherited Members

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

Member Typedef Documentation

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

Definition at line 67 of file itkLevelSetNeighborhoodExtractor.h.

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

Index type alias support

Definition at line 89 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 79 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 77 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 78 of file itkLevelSetNeighborhoodExtractor.h.

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

LevelSetType type alias support

Definition at line 76 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 82 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 83 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 81 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 80 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 66 of file itkLevelSetNeighborhoodExtractor.h.

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

Standard class typdedefs.

Definition at line 64 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 65 of file itkLevelSetNeighborhoodExtractor.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<typename TLevelSet >
virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::CalculateDistance ( IndexType index)
protectedvirtual
template<typename TLevelSet >
virtual::itk::LightObject::Pointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

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

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

This method causes the filter to generate its output.

Reimplemented from itk::LightProcessObject.

template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateDataFull ( )
private
template<typename TLevelSet >
void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateDataNarrowBand ( )
private
template<typename TLevelSet >
virtual const LevelSetImageType* itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetInputLevelSet ( ) const
virtual

Get/Set the input level set.

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

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

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.

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

Definition at line 142 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 154 of file itkLevelSetNeighborhoodExtractor.h.

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

Get the value of the level set to be located.

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

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

template<typename TLevelSet >
virtual const char* itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

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

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

Get the narrowbanding flag.

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

Get the narrow band width.

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

Definition at line 145 of file itkLevelSetNeighborhoodExtractor.h.

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 130 of file itkLevelSetNeighborhoodExtractor.h.

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

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

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

Get the narrowbanding flag.

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

Get the narrowbanding flag.

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

Method for creation through the object factory.

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

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

Get/Set the input level set.

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

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

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.

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

Set the narrowbanding flag.

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

Set the narrow band width. Default is 12.

Member Data Documentation

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

Definition at line 173 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 167 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 171 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 164 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 174 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 178 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 162 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 169 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 170 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 176 of file itkLevelSetNeighborhoodExtractor.h.

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

Definition at line 165 of file itkLevelSetNeighborhoodExtractor.h.

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

SetDimension enumeration.

Definition at line 86 of file itkLevelSetNeighborhoodExtractor.h.


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