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

Implemenation 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
typedef SmartPointer< const Self >	ConstPointer

typedef Index < itkGetStaticConstMacro(SetDimension) >	IndexType

typedef LevelSetType::LevelSetConstPointer	LevelSetConstPointer

typedef LevelSetType::LevelSetImageType	LevelSetImageType

typedef LevelSetType::LevelSetPointer	LevelSetPointer

typedef LevelSetTypeDefault < TLevelSet >	LevelSetType

typedef LevelSetType::NodeContainer	NodeContainer

typedef LevelSetType::NodeContainerPointer	NodeContainerPointer

typedef LevelSetType::NodeType	NodeType

typedef LevelSetType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef LevelSetNeighborhoodExtractor	Self

typedef LightProcessObject	Superclass

Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

NodeContainerPointer	GetInsidePoints ()

virtual double	GetLevelSetValue () const

virtual const char *	GetNameOfClass () const

virtual double	GetNarrowBandwidth () const

NodeContainerPointer	GetOutsidePoints (void)

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 ()

virtual void	NarrowBandingOff ()


void	SetInputNarrowBand (NodeContainer *ptr)

virtual NodeContainer *	GetModifiableInputNarrowBand ()

virtual const NodeContainer *	GetInputNarrowBand () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

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 const unsigned int	SetDimension = LevelSetType::SetDimension

Protected Member Functions
virtual double	CalculateDistance (IndexType &index)

virtual void	GenerateData () ITK_OVERRIDE

LevelSetImageType::PixelType	GetLargeValue () const

bool	GetLastPointIsInside () const

const NodeType &	GetNodeUsedInCalculation (unsigned int idx) const

virtual void	Initialize ()

	LevelSetNeighborhoodExtractor ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE

	~LevelSetNeighborhoodExtractor ()

Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()

	~LightProcessObject ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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 ()

	LevelSetNeighborhoodExtractor (const Self &)

void	operator= (const Self &)

Private Attributes
SizeValueType	m_ImageSize [SetDimension]

LevelSetConstPointer	m_InputLevelSet

NodeContainerPointer	m_InputNarrowBand

NodeContainerPointer	m_InsidePoints

LevelSetImageType::PixelType	m_LargeValue

bool	m_LastPointIsInside

double	m_LevelSetValue

bool	m_NarrowBanding

double	m_NarrowBandwidth

std::vector< NodeType >	m_NodesUsed

NodeContainerPointer	m_OutsidePoints

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<typename TLevelSet >

typedef SmartPointer< const Self > itk::LevelSetNeighborhoodExtractor< TLevelSet >::ConstPointer

Definition at line 65 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef Index< itkGetStaticConstMacro(SetDimension) > itk::LevelSetNeighborhoodExtractor< TLevelSet >::IndexType

Index typedef support.

Definition at line 88 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::LevelSetConstPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetConstPointer

Definition at line 77 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::LevelSetImageType itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetImageType

Definition at line 75 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::LevelSetPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetPointer

Definition at line 76 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetTypeDefault< TLevelSet > itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetType

LevelSetType typedef support.

Definition at line 71 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::NodeContainer itk::LevelSetNeighborhoodExtractor< TLevelSet >::NodeContainer

Definition at line 80 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::NodeContainerPointer

Definition at line 81 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::NodeType itk::LevelSetNeighborhoodExtractor< TLevelSet >::NodeType

Definition at line 79 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetType::PixelType itk::LevelSetNeighborhoodExtractor< TLevelSet >::PixelType

Definition at line 78 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef SmartPointer< Self > itk::LevelSetNeighborhoodExtractor< TLevelSet >::Pointer

Definition at line 64 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LevelSetNeighborhoodExtractor itk::LevelSetNeighborhoodExtractor< TLevelSet >::Self

Standard class typdedefs.

Definition at line 62 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

typedef LightProcessObject itk::LevelSetNeighborhoodExtractor< TLevelSet >::Superclass

Definition at line 63 of file itkLevelSetNeighborhoodExtractor.h.

Constructor & Destructor Documentation

template<typename TLevelSet >

itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetNeighborhoodExtractor ( )

protected

template<typename TLevelSet >

itk::LevelSetNeighborhoodExtractor< TLevelSet >::~LevelSetNeighborhoodExtractor ( )

inlineprotected

Definition at line 138 of file itkLevelSetNeighborhoodExtractor.h.

template<typename TLevelSet >

itk::LevelSetNeighborhoodExtractor< TLevelSet >::LevelSetNeighborhoodExtractor ( const Self & )

private

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 ( void ) 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 >

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateData ( void )

protectedvirtual

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

References itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_InsidePoints.

template<typename TLevelSet >

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

inlineprotected

Definition at line 141 of file itkLevelSetNeighborhoodExtractor.h.

References itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_LargeValue.

template<typename TLevelSet >

bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLastPointIsInside ( ) const

inlineprotected

Definition at line 153 of file itkLevelSetNeighborhoodExtractor.h.

References itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_LastPointIsInside.

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

References itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_NodesUsed.

template<typename TLevelSet >

NodeContainerPointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetOutsidePoints ( void )

inline

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

Definition at line 129 of file itkLevelSetNeighborhoodExtractor.h.

References itk::LevelSetNeighborhoodExtractor< TLevelSet >::m_OutsidePoints.

template<typename TLevelSet >

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::Initialize ( )

protectedvirtual

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

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 >::operator= ( const Self & )

private

template<typename TLevelSet >

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

protectedvirtual

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