itk::SpatialFunction< TOutput, VImageDimension, TInput > Class Template Reference

ITK 4.2.0

Insight Segmentation and Registration Toolkit

#include <itkSpatialFunction.h>

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

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

List of all members.

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

Public Member Functions
virtual OutputType	Evaluate (const InputType &input) const =0
virtual const char *	GetNameOfClass () 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 &)

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.

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

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.

Reimplemented from itk::FunctionBase< TInput, TOutput >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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.

Reimplemented from itk::FunctionBase< TInput, TOutput >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::FrustumSpatialFunction< VImageDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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

Reimplemented from itk::FunctionBase< TInput, TOutput >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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.

Reimplemented from itk::FunctionBase< TInput, TOutput >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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

Reimplemented from itk::FunctionBase< TInput, TOutput >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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

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

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

void itk::SpatialFunction< TOutput, VImageDimension, TInput >::operator= ( const Self & )

private

Reimplemented from itk::FunctionBase< TInput, TOutput >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, and itk::SphereSpatialFunction< VImageDimension, TInput >.

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:

itkSpatialFunction.h