#include <itkBinaryThresholdSpatialFunction.h>

Inheritance diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

Collaboration diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

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 42 of file itkBinaryThresholdSpatialFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FunctionOutputType = typename TFunction::OutputType

using	FunctionType = TFunction

using	InputType = typename TFunction::InputType

using	OutputType = typename Superclass::OutputType

using	Pointer = SmartPointer< Self >

using	Self = BinaryThresholdSpatialFunction

using	Superclass = SpatialFunction< bool, TFunction::ImageDimension, typename TFunction::InputType >

Public Types inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
using	ConstPointer = SmartPointer< const Self >

using	InputType = typename Superclass::InputType

using	OutputType = typename Superclass::OutputType

using	Pointer = SmartPointer< Self >

using	Self = SpatialFunction

using	Superclass = FunctionBase< TFunction::InputType, bool >

Public Types inherited from itk::FunctionBase< TFunction::InputType, bool >
using	ConstPointer = SmartPointer< const Self >

using	InputType = TFunction::InputType

using	OutputType = bool

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

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

OutputType	Evaluate (const InputType &point) const override

virtual const char *	GetNameOfClass () const


virtual void	SetLowerThreshold (FunctionOutputType _arg)

virtual const FunctionOutputType &	GetLowerThreshold () const


virtual void	SetUpperThreshold (FunctionOutputType _arg)

virtual const FunctionOutputType &	GetUpperThreshold () const


virtual void	SetFunction (FunctionType *_arg)

virtual FunctionType *	GetModifiableFunction ()

virtual const FunctionType *	GetFunction () const

Public Member Functions inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
OutputType	Evaluate (const InputType &input) const override=0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) 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

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)

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

Protected Member Functions
	BinaryThresholdSpatialFunction ()

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

	~BinaryThresholdSpatialFunction () override=default

Protected Member Functions inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
void	PrintSelf (std::ostream &os, Indent indent) const override

	SpatialFunction ()=default

	~SpatialFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< TFunction::InputType, bool >
	FunctionBase ()=default

	~FunctionBase () override=default

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

Protected Attributes
FunctionType::Pointer	m_Function

FunctionOutputType	m_LowerThreshold

FunctionOutputType	m_UpperThreshold

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

Additional Inherited Members
Static Public Attributes inherited from itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >
static constexpr unsigned int	ImageDimension

Member Typedef Documentation

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::ConstPointer = SmartPointer< const Self >

Definition at line 57 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::FunctionOutputType = typename TFunction::OutputType

Underlying function output type.

Definition at line 75 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::FunctionType = TFunction

Underlying function type.

Definition at line 72 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::InputType = typename TFunction::InputType

InputType type alias support.

Definition at line 69 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::OutputType = typename Superclass::OutputType

OutputType type alias support.

Definition at line 66 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::Pointer = SmartPointer< Self >

Definition at line 56 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::Self = BinaryThresholdSpatialFunction

Standard class type aliases.

Definition at line 51 of file itkBinaryThresholdSpatialFunction.h.

template<typename TFunction >

using itk::BinaryThresholdSpatialFunction< TFunction >::Superclass = SpatialFunction< bool, TFunction::ImageDimension, typename TFunction::InputType >

Definition at line 54 of file itkBinaryThresholdSpatialFunction.h.

Constructor & Destructor Documentation

template<typename TFunction >

itk::BinaryThresholdSpatialFunction< TFunction >::BinaryThresholdSpatialFunction ( )

protected

template<typename TFunction >

itk::BinaryThresholdSpatialFunction< TFunction >::~BinaryThresholdSpatialFunction ( )

overrideprotecteddefault

Member Function Documentation

template<typename TFunction >

virtual::itk::LightObject::Pointer itk::BinaryThresholdSpatialFunction< TFunction >::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::LightObject.

template<typename TFunction >

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

override

Evaluate the function at a given position.

template<typename TFunction >

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

virtual

Set/Get the underlying function.

template<typename TFunction >

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

virtual

Set/Get the lower threshold.

template<typename TFunction >

virtual FunctionType* itk::BinaryThresholdSpatialFunction< TFunction >::GetModifiableFunction ( )

virtual

Set/Get the underlying function.

template<typename TFunction >

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

virtual

Run-time type information (and related methods).

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

template<typename TFunction >

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

virtual

Set/Get the upper threshold.

template<typename TFunction >

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

static

New macro for creation of through the object factory.

template<typename TFunction >

void itk::BinaryThresholdSpatialFunction< TFunction >::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::LightObject.

template<typename TFunction >

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

virtual

Set/Get the underlying function.

template<typename TFunction >

virtual void itk::BinaryThresholdSpatialFunction< TFunction >::SetLowerThreshold ( FunctionOutputType _arg )

virtual

Set/Get the lower threshold.

template<typename TFunction >

virtual void itk::BinaryThresholdSpatialFunction< TFunction >::SetUpperThreshold ( FunctionOutputType _arg )

virtual