itk::InteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkInteriorExteriorSpatialFunction.h>

Detailed Description

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
class itk::InteriorExteriorSpatialFunction< VDimension, TInput >

Returns whether or not a location is "inside" or "outside" a function.

InteriorExteriorSpatialFunction is a specialized version of SpatialFunction where the output type is a boolean. In particular, the return type is understood to mean the following:

A return of 1 means inside or on the surface of the function, 0 means outside the function

There is no implied meaning in the terms "inside" or "outside"; although the standard assumption is that "inside" means "bounded by a closed surface", alternative definitions are also fine. For example, inside might be one side of a plane, outside the other side.

A typical use for an InteriorExteriorSpatialFunction is to generate test primitives of arbitrary dimensionality, in conjunction with itk::SpatialFunctionImageEvaluatorFilter or itk::FloodFilledSpatialFunctionConditionalIterator

Definition at line 49 of file itkInteriorExteriorSpatialFunction.h.

Inheritance diagram for itk::InteriorExteriorSpatialFunction< VDimension, TInput >:

Collaboration diagram for itk::InteriorExteriorSpatialFunction< VDimension, TInput >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = InteriorExteriorSpatialFunction
using	Superclass = SpatialFunction< bool, VDimension, TInput >
Public Types inherited from itk::SpatialFunction< bool, VDimension, TInput >
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = SpatialFunction
using	Superclass = FunctionBase< TInput, bool >
Public Types inherited from itk::FunctionBase< TInput, bool >
using	ConstPointer = SmartPointer< const Self >
using	InputType = TInput
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
OutputType	Evaluate (const InputType &input) const override=0
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
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

Protected Member Functions
	InteriorExteriorSpatialFunction ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~InteriorExteriorSpatialFunction () override=default
Protected Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
void	PrintSelf (std::ostream &os, Indent indent) const override
	SpatialFunction ()=default
	~SpatialFunction () override=default
Protected Member Functions inherited from itk::FunctionBase< TInput, 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 ()

Additional Inherited Members
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 ()
Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, TInput >
static constexpr unsigned int	ImageDimension
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

using itk::InteriorExteriorSpatialFunction< VDimension, TInput >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkInteriorExteriorSpatialFunction.h.

Pointer

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

using itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkInteriorExteriorSpatialFunction.h.

Self

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

using itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Self = InteriorExteriorSpatialFunction

Standard class type aliases.

Definition at line 55 of file itkInteriorExteriorSpatialFunction.h.

Superclass

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

using itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Superclass = SpatialFunction<bool, VDimension, TInput>

Definition at line 56 of file itkInteriorExteriorSpatialFunction.h.

Constructor & Destructor Documentation

InteriorExteriorSpatialFunction()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

itk::InteriorExteriorSpatialFunction< VDimension, TInput >::InteriorExteriorSpatialFunction ( )

protecteddefault

~InteriorExteriorSpatialFunction()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

itk::InteriorExteriorSpatialFunction< VDimension, TInput >::~InteriorExteriorSpatialFunction ( )

overrideprotecteddefault

Member Function Documentation

Evaluate()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

OutputType itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Evaluate ( const InputType &  input ) const

overridepure virtual

Evaluate the function at a given position. A return of 1 means inside or on the surface of the function, 0 means outside the function The actual definition of inside/outside is left up to the subclass

Implements itk::SpatialFunction< bool, VDimension, TInput >.

Implemented in itk::FrustumSpatialFunction< VDimension, TInput >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

GetNameOfClass()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

const char* itk::InteriorExteriorSpatialFunction< VDimension, TInput >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >.

PrintSelf()

template<unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>

void itk::InteriorExteriorSpatialFunction< VDimension, TInput >::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.

Reimplemented in itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >.

---

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

• itkInteriorExteriorSpatialFunction.h