A spatial functions that returns if the internal spatial function is within user specified thresholds. More...

#include <itkBinaryThresholdSpatialFunction.h>

Inheritance diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

Collaboration diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TFunction::OutputType	FunctionOutputType
typedef TFunction	FunctionType
typedef TFunction::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef BinaryThresholdSpatialFunction	Self
typedef SpatialFunction< bool,::itk::GetImageDimension < TFunction >::ImageDimension, typename TFunction::InputType >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual OutputType	Evaluate (const InputType &point) const
virtual OutputType	Evaluate (const InputType &input) const =0
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const


virtual void	SetLowerThreshold (FunctionOutputType _arg)
virtual const FunctionOutputType &	GetLowerThreshold ()


virtual void	SetUpperThreshold (FunctionOutputType _arg)
virtual const FunctionOutputType &	GetUpperThreshold ()


virtual void	SetFunction (FunctionType *_arg)
virtual const FunctionType *	GetFunction ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	ImageDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
	BinaryThresholdSpatialFunction ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	~BinaryThresholdSpatialFunction ()


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
FunctionType::Pointer	m_Function
FunctionOutputType	m_LowerThreshold
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
FunctionOutputType	m_UpperThreshold

Detailed Description

template<typename TFunction>
class itk::BinaryThresholdSpatialFunction< TFunction >

A spatial functions that returns if the internal spatial function is within user specified thresholds.

BinaryThresholdSpatialFunction is a wrapper class for an internal spatial function and returns true if it is within user specified thresholds and false otherwise.

This class is templated over the internal spatial function type.

See also:: SpatialFunction

Definition at line 41 of file itkBinaryThresholdSpatialFunction.h.

Member Typedef Documentation

template<typename TFunction >

typedef SmartPointer<const Self> itk::BinaryThresholdSpatialFunction< TFunction >::ConstPointer

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

Definition at line 53 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

typedef TFunction::OutputType itk::BinaryThresholdSpatialFunction< TFunction >::FunctionOutputType

Underlying function output type.

Definition at line 71 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

typedef TFunction itk::BinaryThresholdSpatialFunction< TFunction >::FunctionType

Underlying function type.

Definition at line 68 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

typedef TFunction::InputType itk::BinaryThresholdSpatialFunction< TFunction >::InputType

InputType typedef support.

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

Definition at line 65 of file itkBinaryThresholdSpatialFunction.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<typename TFunction >

typedef Superclass::OutputType itk::BinaryThresholdSpatialFunction< TFunction >::OutputType

OutputType typedef support.

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

Definition at line 59 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

typedef SmartPointer<Self> itk::BinaryThresholdSpatialFunction< TFunction >::Pointer

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

Definition at line 52 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

typedef BinaryThresholdSpatialFunction itk::BinaryThresholdSpatialFunction< TFunction >::Self

Standard class typedefs.

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

Definition at line 48 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

typedef SpatialFunction< bool, ::itk::GetImageDimension<TFunction>::ImageDimension, typename TFunction::InputType > itk::BinaryThresholdSpatialFunction< TFunction >::Superclass

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

Definition at line 51 of file itkBinaryThresholdSpatialFunction.h.

Constructor & Destructor Documentation

template<typename TFunction >

itk::BinaryThresholdSpatialFunction< TFunction >::BinaryThresholdSpatialFunction ( ) [protected]

template<typename TFunction >

itk::BinaryThresholdSpatialFunction< TFunction >::~BinaryThresholdSpatialFunction ( ) [protected]

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

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.

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.

virtual OutputType itk::SpatialFunction< bool , VImageDimension, TFunction::InputType >::Evaluate ( const InputType & input ) const [pure virtual, inherited]

Evaluate the function at a given position. Remember, position is represented by an n-d itk::Point object with data type double.

Implements itk::FunctionBase< TFunction::InputType, bool >.

template<typename TFunction >

virtual OutputType itk::BinaryThresholdSpatialFunction< TFunction >::Evaluate ( const InputType & point ) const [virtual]

Evaluate the function at a given position.

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.

template<typename TFunction >

virtual const FunctionType* itk::BinaryThresholdSpatialFunction< TFunction >::GetFunction ( ) [virtual]

Set/Get the underlying function.

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

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

template<typename TFunction >

virtual const FunctionOutputType& itk::BinaryThresholdSpatialFunction< TFunction >::GetLowerThreshold ( ) [virtual]

Set/Get the lower threshold.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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

Returns:: A constant reference to this objects MetaDataDictionary.

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

Return this objects modified time.

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

template<typename TFunction >

virtual const char* itk::BinaryThresholdSpatialFunction< TFunction >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<typename TFunction >

virtual const FunctionOutputType& itk::BinaryThresholdSpatialFunction< TFunction >::GetUpperThreshold ( ) [virtual]

Set/Get the upper threshold.

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

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.

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

Call Execute on all the Commands observing this event id.

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.

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, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<typename TFunction >

static Pointer itk::BinaryThresholdSpatialFunction< TFunction >::New ( ) [static]

New macro for creation of through the object factory.

Reimplemented from itk::Object.

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

Cause the object to print itself out.

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

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

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.

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

template<typename TFunction >

void itk::BinaryThresholdSpatialFunction< TFunction >::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::SpatialFunction< bool,::itk::GetImageDimension< TFunction >::ImageDimension, TFunction::InputType >.

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

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.

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.

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

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

template<typename TFunction >

virtual void itk::BinaryThresholdSpatialFunction< TFunction >::SetFunction ( FunctionType * _arg ) [virtual]