ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep > Class Template Reference
Module ITKMetricsv4

#include <itkPointSetFunction.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TCoordRep CoordRepType
typedef
InputPointSetType::PixelType 		InputPixelType
typedef
InputPointSetType::ConstPointer 		InputPointSetConstPointer
typedef TInputPointSet InputPointSetType
typedef
InputPointSetType::PointType 		InputPointType
typedef TOutput OutputType
typedef SmartPointer< Self > Pointer
typedef PointSetFunction Self
typedef FunctionBase< typename
TInputPointSet::PointType,
TOutput > 		Superclass

Public Member Functions

virtual TOutput Evaluate (const InputPointType &point) const =0
const InputPointSetType * GetInputPointSet () const
virtual const char * GetNameOfClass () const
virtual void SetInputPointSet (const InputPointSetType *ptr)

Static Public Attributes

static const unsigned int Dimension = TInputPointSet::PointDimension

Protected Member Functions

 PointSetFunction ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~PointSetFunction ()

Protected Attributes

InputPointSetConstPointer m_PointSet

Private Member Functions

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

Detailed Description

template<class TInputPointSet, class TOutput, class 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.

Member Typedef Documentation

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

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

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 73 of file itkPointSetFunction.h.

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

CoordRepType typedef support.

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 92 of file itkPointSetFunction.h.

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

Definition at line 83 of file itkPointSetFunction.h.

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

InputPointSetPointer typedef support

Definition at line 86 of file itkPointSetFunction.h.

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

InputPointSetType typedef support.

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 76 of file itkPointSetFunction.h.

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

InputPixel typedef support

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 82 of file itkPointSetFunction.h.

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

OutputType typedef support.

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

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 89 of file itkPointSetFunction.h.

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

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

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 72 of file itkPointSetFunction.h.

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

Standard class typedefs.

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

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 69 of file itkPointSetFunction.h.

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

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

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

Definition at line 71 of file itkPointSetFunction.h.

Constructor & Destructor Documentation

template<class TInputPointSet, class TOutput, class TCoordRep = float>
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PointSetFunction ( ) [protected]
template<class TInputPointSet, class TOutput, class TCoordRep = float>
virtual itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::~PointSetFunction ( ) [protected, virtual]
template<class TInputPointSet, class TOutput, class TCoordRep = float>
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PointSetFunction ( const Self &  ) [private]

Member Function Documentation

template<class TInputPointSet, class TOutput, class TCoordRep = float>
virtual TOutput itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Evaluate ( const InputPointType &  point) const [pure virtual]

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

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

Mutex lock to protect modification to the reference count

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

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

template<class TInputPointSet, class TOutput, class TCoordRep = float>
void itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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.

Reimplemented in itk::ManifoldParzenWindowsPointSetFunction< TPointSet, TOutput, TCoordRep >.

template<class TInputPointSet, class TOutput, class 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<class TInputPointSet, class TOutput, class 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<class TInputPointSet, class TOutput, class 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.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 01:18:32 for ITK by doxygen 1.7.6.1