itk::SpatialFunction< TOutput, VImageDimension, TInput > Class Template Reference
[Spatial Functions]

N-dimensional spatial function class. More...

#include <itkSpatialFunction.h>

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

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

[legend]List of all members.

Public Types
typedef SpatialFunction	Self
typedef FunctionBase< TInput, TOutput >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
virtual OutputType	Evaluate (const InputType &input) const=0
Protected Member Functions
	SpatialFunction ()
virtual	~SpatialFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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

---

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

Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >. Definition at line 53 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. Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >. Definition at line 59 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. Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >. Definition at line 62 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

Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >. Definition at line 52 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. Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >. Definition at line 50 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

Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >. Definition at line 51 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 (   )  [protected, virtual]

---

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]

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< TInput, TOutput >. Implemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >.

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual const char* itk::SpatialFunction< TOutput, VImageDimension, TInput >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::FunctionBase< TInput, TOutput >. Reimplemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >.

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> itk::SpatialFunction< TOutput, VImageDimension, TInput >::itkStaticConstMacro (  ImageDimension  , unsigned  int, VImageDimension  )

Spatial dimension.

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 [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::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >.

---

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

• itkSpatialFunction.h

---