ITK: itk::LevelSetNeighborhoodExtractor< TLevelSet

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TLevelSet>

virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::CalculateDistance ( IndexType & index ) [protected, virtual]

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TLevelSet>

void itk::LevelSetNeighborhoodExtractor< TLevelSet >::GenerateData ( void ) [protected, virtual]

This method causes the filter to generate its output.

Reimplemented from itk::LightProcessObject.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

template<class TLevelSet>

virtual const LevelSetImageType* itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetInputLevelSet ( ) [virtual]

Get the input level set.

template<class TLevelSet>

virtual NodeContainer* itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetInputNarrowBand ( ) [virtual]

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

template<class TLevelSet>

LevelSetImageType::PixelType itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLargeValue ( ) const [inline, protected]

Definition at line 141 of file itkLevelSetNeighborhoodExtractor.h.

template<class TLevelSet>

bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLastPointIsInside ( ) const [inline, protected]

Definition at line 152 of file itkLevelSetNeighborhoodExtractor.h.

template<class TLevelSet>

virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetLevelSetValue ( ) [virtual]

Get the value of the level set to be located.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class 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<class TLevelSet>

virtual bool itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNarrowBanding ( ) [virtual]

Get the narrowbanding flag.

template<class TLevelSet>

virtual double itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNarrowBandwidth ( ) [virtual]

Get the narrow band width.

template<class TLevelSet>

const NodeType& itk::LevelSetNeighborhoodExtractor< TLevelSet >::GetNodeUsedInCalculation ( unsigned int idx ) const [inline, protected]

Definition at line 144 of file itkLevelSetNeighborhoodExtractor.h.

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

virtual const float& itk::LightProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::Initialize ( ) [protected, virtual]

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

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TLevelSet>

itk::LevelSetNeighborhoodExtractor< TLevelSet >::itkStaticConstMacro	(	SetDimension	,
		unsigned	int,
		LevelSetType::SetDimension
	)

SetDimension enumeration.

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

template<class TLevelSet>

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

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

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::NarrowBandingOff ( ) [virtual]

Get the narrowbanding flag.

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::NarrowBandingOn ( ) [virtual]

Get the narrowbanding flag.

template<class TLevelSet>

static Pointer itk::LevelSetNeighborhoodExtractor< TLevelSet >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

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

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TLevelSet>

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

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

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetInputLevelSet ( const LevelSetImageType * _arg ) [virtual]

Set the input level set.

template<class TLevelSet>

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

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

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetLevelSetValue ( double _arg ) [virtual]

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetNarrowBanding ( bool _arg ) [virtual]

Set the narrowbanding flag.

template<class TLevelSet>

virtual void itk::LevelSetNeighborhoodExtractor< TLevelSet >::SetNarrowBandwidth ( double _arg ) [virtual]

Set the narrow band width. Default is 12.

virtual void itk::LightProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::LightProcessObject::UpdateOutputData ( ) [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

volatile int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

itk::LevelSetNeighborhoodExtractor< TLevelSet > Class Template Reference
[Level Set-Based Segmentation Filters]

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


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 Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const LevelSetImageType *	GetInputLevelSet ()
NodeContainerPointer	GetInsidePoints ()
virtual double	GetLevelSetValue ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual double	GetNarrowBandwidth ()
NodeContainerPointer	GetOutsidePoints (void)
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (SetDimension, unsigned int, LevelSetType::SetDimension)
void	Locate ()
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetInputLevelSet (const LevelSetImageType *_arg)
virtual void	SetLevelSetValue (double _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNarrowBanding (bool _arg)
virtual void	SetNarrowBandwidth (double _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual NodeContainer *	GetInputNarrowBand ()
void	SetInputNarrowBand (NodeContainer *ptr)

virtual bool	GetNarrowBanding ()
virtual void	NarrowBandingOff ()
virtual void	NarrowBandingOn ()

virtual const float &	GetProgress ()

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
virtual double	CalculateDistance (IndexType &index)
void	GenerateData ()
LevelSetImageType::PixelType	GetLargeValue () const
bool	GetLastPointIsInside () const
const NodeType &	GetNodeUsedInCalculation (unsigned int idx) const
virtual void	Initialize ()
	LevelSetNeighborhoodExtractor ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	~LevelSetNeighborhoodExtractor ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

itk::LevelSetNeighborhoodExtractor< TLevelSet > Class Template Reference [Level Set-Based Segmentation Filters]

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::LevelSetNeighborhoodExtractor< TLevelSet > Class Template Reference
[Level Set-Based Segmentation Filters]

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