#include <itkSpatialFunction.h>

Detailed Description

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
class itk::SpatialFunction< TOutput, VImageDimension, TInput >

N-dimensional spatial function class.

itk::SpatialFunction provides the ability to define functions that can be evaluated at an arbitrary point in space (physical or otherwise). The return type is specified by the derived class, and the input to the function is an n-dimensional itk::Point.

Although itk::ImageFunction and itk::SpatialFunction are quite similar, itk::SpatialFunction derived classes exist without reference to an Image type.

SpatialFunction is templated over output type (the data type returned by an evaluate() call) and dimensionality.

Definition at line 45 of file itkSpatialFunction.h.

Inheritance diagram for itk::SpatialFunction< TOutput, VImageDimension, TInput >:

Collaboration diagram for itk::SpatialFunction< TOutput, VImageDimension, TInput >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = SpatialFunction

using	Superclass = FunctionBase< TInput, TOutput >

Public Types inherited from itk::FunctionBase< Point< double, 3 >, TOutput >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< double, 3 >

using	OutputType = TOutput

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::FunctionBase< Point< double, 3 >, TOutput >
virtual OutputType	Evaluate (const InputType &input) const=0

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

const char *	GetNameOfClass () const override

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

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Attributes
static constexpr unsigned int	ImageDimension = VImageDimension

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

	SpatialFunction ()=default

	~SpatialFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< double, 3 >, TOutput >
	FunctionBase ()=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

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

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

Member Typedef Documentation

◆ ConstPointer

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

using itk::SpatialFunction< TOutput, VImageDimension, TInput >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkSpatialFunction.h.

◆ Pointer

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

using itk::SpatialFunction< TOutput, VImageDimension, TInput >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkSpatialFunction.h.

◆ Self

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

using itk::SpatialFunction< TOutput, VImageDimension, TInput >::Self = SpatialFunction

Standard class type aliases.

Definition at line 51 of file itkSpatialFunction.h.

◆ Superclass

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

using itk::SpatialFunction< TOutput, VImageDimension, TInput >::Superclass = FunctionBase<TInput, TOutput>

Definition at line 52 of file itkSpatialFunction.h.

Constructor & Destructor Documentation

◆ SpatialFunction()

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

itk::SpatialFunction< TOutput, VImageDimension, TInput >::SpatialFunction ( )

protecteddefault

◆ ~SpatialFunction()

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

itk::SpatialFunction< TOutput, VImageDimension, TInput >::~SpatialFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

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

OutputType itk::SpatialFunction< TOutput, VImageDimension, TInput >::Evaluate ( const InputType & input ) const

overridepure virtual

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< Point< double, 3 >, TOutput >.

Implemented in itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, and itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

◆ GetNameOfClass()

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

const char * itk::SpatialFunction< TOutput, VImageDimension, TInput >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ PrintSelf()

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

void itk::SpatialFunction< TOutput, VImageDimension, 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::Object.

Member Data Documentation

◆ ImageDimension

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

constexpr unsigned int itk::SpatialFunction< TOutput, VImageDimension, TInput >::ImageDimension = VImageDimension

staticconstexpr

Spatial dimension.

Definition at line 66 of file itkSpatialFunction.h.

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

itkSpatialFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ SpatialFunction()

◆ ~SpatialFunction()

Member Function Documentation

◆ Evaluate()

◆ GetNameOfClass()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension