ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::SpatialFunction< TOutput, VImageDimension, TInput > Class Template Referenceabstract

#include <itkSpatialFunction.h>

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

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 47 of file itkSpatialFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef SpatialFunction Self
 
typedef FunctionBase< TInput,
TOutput > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TInput, TOutput >
typedef SmartPointer< const SelfConstPointer
 
typedef TInput InputType
 
typedef TOutput OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual OutputType Evaluate (const InputType &input) const =0
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const ITK_OVERRIDE
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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 Attributes

static const unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 
 SpatialFunction ()
 
virtual ~SpatialFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< TInput, TOutput >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Private Member Functions

void operator= (const Self &)
 
 SpatialFunction (const Self &)
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
typedef SmartPointer< const Self > itk::SpatialFunction< TOutput, VImageDimension, TInput >::ConstPointer

Definition at line 54 of file itkSpatialFunction.h.

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

Input type for the function.

Definition at line 57 of file itkSpatialFunction.h.

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

Output type for the function.

Definition at line 63 of file itkSpatialFunction.h.

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
typedef SmartPointer< Self > itk::SpatialFunction< TOutput, VImageDimension, TInput >::Pointer

Definition at line 53 of file itkSpatialFunction.h.

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

Standard class typedefs.

Definition at line 51 of file itkSpatialFunction.h.

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

Definition at line 52 of file itkSpatialFunction.h.

Constructor & Destructor Documentation

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
itk::SpatialFunction< TOutput, VImageDimension, TInput >::SpatialFunction ( )
protected
template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
virtual itk::SpatialFunction< TOutput, VImageDimension, TInput >::~SpatialFunction ( )
protectedvirtual
template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
itk::SpatialFunction< TOutput, VImageDimension, TInput >::SpatialFunction ( const Self )
private

Member Function Documentation

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
virtual OutputType itk::SpatialFunction< TOutput, VImageDimension, TInput >::Evaluate ( const InputType input) const
pure virtual
template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
virtual const char* itk::SpatialFunction< TOutput, VImageDimension, TInput >::GetNameOfClass ( ) const
virtual
template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>
void itk::SpatialFunction< TOutput, VImageDimension, TInput >::operator= ( const Self )
private
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
protectedvirtual

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

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

Spatial dimension.

Definition at line 66 of file itkSpatialFunction.h.


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