#include <itkBinaryThresholdSpatialFunction.h>

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.

Inheritance diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

Collaboration diagram for itk::BinaryThresholdSpatialFunction< TFunction >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	FunctionOutputType = typename TFunction::OutputType

using	FunctionType = TFunction

using	InputType = typename TFunction::InputType

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

typedef TFunction::InputType	InputType

using	InputType

typedef bool	OutputType

using	OutputType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::FunctionBase< TFunction::InputType, bool >
using	ConstPointer

using	InputType

using	OutputType

using	Pointer

using	Self

using	Superclass

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

const char *	GetNameOfClass () const override


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 >
const char *	GetNameOfClass () const override

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

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
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	BinaryThresholdSpatialFunction ()=default

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 &timeStamp)

	~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 { NumericTraits<FunctionOutputType>::NonpositiveMin() }

FunctionOutputType	m_UpperThreshold { NumericTraits<FunctionOutputType>::max() }

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

◆ ConstPointer

template<typename TFunction>

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

Definition at line 53 of file itkBinaryThresholdSpatialFunction.h.

◆ FunctionOutputType

template<typename TFunction>

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

Underlying function output type.

Definition at line 71 of file itkBinaryThresholdSpatialFunction.h.

◆ FunctionType

template<typename TFunction>

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

Underlying function type.

Definition at line 68 of file itkBinaryThresholdSpatialFunction.h.

◆ InputType

template<typename TFunction>

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

InputType type alias support.

Definition at line 65 of file itkBinaryThresholdSpatialFunction.h.

◆ Pointer

template<typename TFunction>

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

Definition at line 52 of file itkBinaryThresholdSpatialFunction.h.

◆ Self

template<typename TFunction>

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

Standard class type aliases.

Definition at line 49 of file itkBinaryThresholdSpatialFunction.h.

◆ Superclass

template<typename TFunction>

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

Definition at line 50 of file itkBinaryThresholdSpatialFunction.h.

Constructor & Destructor Documentation

◆ BinaryThresholdSpatialFunction()

template<typename TFunction>

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

protecteddefault

Referenced by GetNameOfClass().

◆ ~BinaryThresholdSpatialFunction()

template<typename TFunction>

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

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.

◆ Evaluate()

template<typename TFunction>

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

overridevirtual

Evaluate the function at a given position.

Implements itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >.

References itk::point().

◆ GetFunction()

template<typename TFunction>

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

virtual

Set/Get the underlying function.

◆ GetLowerThreshold()

template<typename TFunction>

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

virtual

Set/Get the lower threshold.

◆ GetModifiableFunction()

template<typename TFunction>

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

virtual

Set/Get the underlying function.

◆ GetNameOfClass()

template<typename TFunction>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References BinaryThresholdSpatialFunction().

◆ GetUpperThreshold()

template<typename TFunction>

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

virtual

Set/Get the upper threshold.

◆ New()

template<typename TFunction>

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

static

New macro for creation of through the object factory.

◆ PrintSelf()

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.

◆ SetFunction()

template<typename TFunction>

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

virtual

Set/Get the underlying function.

◆ SetLowerThreshold()

template<typename TFunction>

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

virtual

Set/Get the lower threshold.

◆ SetUpperThreshold()

template<typename TFunction>

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

virtual

Set/Get the upper threshold.

Member Data Documentation

◆ m_Function

template<typename TFunction>

FunctionType::Pointer itk::BinaryThresholdSpatialFunction< TFunction >::m_Function {}

protected

Definition at line 101 of file itkBinaryThresholdSpatialFunction.h.

◆ m_LowerThreshold

template<typename TFunction>

FunctionOutputType itk::BinaryThresholdSpatialFunction< TFunction >::m_LowerThreshold { NumericTraits<FunctionOutputType>::NonpositiveMin() }

protected

Definition at line 98 of file itkBinaryThresholdSpatialFunction.h.

◆ m_UpperThreshold

template<typename TFunction>

FunctionOutputType itk::BinaryThresholdSpatialFunction< TFunction >::m_UpperThreshold { NumericTraits<FunctionOutputType>::max() }

protected

Definition at line 99 of file itkBinaryThresholdSpatialFunction.h.

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

itkBinaryThresholdSpatialFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FunctionOutputType

◆ FunctionType

◆ InputType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BinaryThresholdSpatialFunction()

◆ ~BinaryThresholdSpatialFunction()

Member Function Documentation

◆ CreateAnother()

◆ Evaluate()

◆ GetFunction()

◆ GetLowerThreshold()

◆ GetModifiableFunction()

◆ GetNameOfClass()

◆ GetUpperThreshold()

◆ New()

◆ PrintSelf()

◆ SetFunction()

◆ SetLowerThreshold()

◆ SetUpperThreshold()

Member Data Documentation

◆ m_Function

◆ m_LowerThreshold

◆ m_UpperThreshold