ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep > Class Template Referenceabstract

#include <itkPointSetFunction.h>

+ Inheritance diagram for itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >:
+ Collaboration diagram for itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >:

Detailed Description

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
class itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >

Evaluates a function of an image at specified position.

FIXME: Documentation was copy-pasted from ImageFunction.

PointSetFunction is a baseclass for all objects that evaluates a function of an image at index, continuous index or point. This class is templated over the input image type, the type of the function output and the coordinate representation type (e.g. float or double).

The input image is set via method SetInputPointSet(). Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluates the function at an geometric point, image index and continuous image index.

Warning
Image BufferedRegion information is cached during in SetInputPointSet( image ). If the image BufferedRegion has changed one must call SetInputPointSet( image ) again to update the cache to the current values.
See Also
Point
Index
ContinuousIndex

Definition at line 60 of file itkPointSetFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TCoordRep CoordRepType
 
typedef
InputPointSetType::PixelType 
InputPixelType
 
typedef
InputPointSetType::ConstPointer 
InputPointSetConstPointer
 
typedef TInputPointSet InputPointSetType
 
typedef
InputPointSetType::PointType 
InputPointType
 
typedef TOutput OutputType
 
typedef SmartPointer< SelfPointer
 
typedef PointSetFunction Self
 
typedef FunctionBase< typename
TInputPointSet::PointType,
TOutput > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TInputPointSet::PointType, TOutput >
typedef SmartPointer< const SelfConstPointer
 
typedef TInputPointSet::PointType 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 TOutput Evaluate (const InputPointType &point) const override=0
 
const InputPointSetTypeGetInputPointSet () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetInputPointSet (const InputPointSetType *ptr)
 
- Public Member Functions inherited from itk::FunctionBase< TInputPointSet::PointType, TOutput >
virtual OutputType Evaluate (const InputType &input) const =0
 
- 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 override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 Dimension = TInputPointSet::PointDimension
 

Protected Member Functions

 PointSetFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~PointSetFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< TInputPointSet::PointType, 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 ()
 

Protected Attributes

InputPointSetConstPointer m_PointSet
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 PointSetFunction (const Self &) ITK_DELETE_FUNCTION
 

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

Member Typedef Documentation

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef SmartPointer<const Self> itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::ConstPointer

Definition at line 73 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef TCoordRep itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::CoordRepType

CoordRepType typedef support.

Definition at line 92 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef InputPointSetType::PixelType itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPixelType

Definition at line 83 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef InputPointSetType::ConstPointer itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPointSetConstPointer

InputPointSetPointer typedef support

Definition at line 86 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef TInputPointSet itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPointSetType

InputPointSetType typedef support.

Definition at line 76 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef InputPointSetType::PointType itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPointType

InputPixel typedef support

Definition at line 82 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef TOutput itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::OutputType

OutputType typedef support.

Definition at line 89 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef SmartPointer<Self> itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Pointer

Definition at line 72 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef PointSetFunction itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Self

Standard class typedefs.

Definition at line 69 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
typedef FunctionBase<typename TInputPointSet::PointType, TOutput> itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Superclass

Definition at line 71 of file itkPointSetFunction.h.

Constructor & Destructor Documentation

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PointSetFunction ( )
protected
template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
virtual itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::~PointSetFunction ( )
protectedvirtual
template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PointSetFunction ( const Self )
private

Member Function Documentation

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
virtual TOutput itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Evaluate ( const InputPointType point) const
overridepure virtual

Evaluate the function at specified Point position. Subclasses must provide this method.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
const InputPointSetType* itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::GetInputPointSet ( ) const
inline

Get the input image.

Definition at line 101 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
virtual const char* itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::FunctionBase< TInputPointSet::PointType, TOutput >.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
void itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::operator= ( const Self )
private
template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
void itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::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.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
virtual void itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::SetInputPointSet ( const InputPointSetType ptr)
virtual

Set the input point set.

Warning
this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputPointSet again to update cached values.

Member Data Documentation

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
const unsigned int itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Dimension = TInputPointSet::PointDimension
static

Dimension underlying input point set.

Definition at line 66 of file itkPointSetFunction.h.

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
InputPointSetConstPointer itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::m_PointSet
protected

Const pointer to the input image.

Definition at line 114 of file itkPointSetFunction.h.

Referenced by itk::PointSetFunction< TPointSet, TOutput, TCoordRep >::GetInputPointSet().


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