ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::FunctionBase< TInput, TOutput > Class Template Referenceabstract

#include <itkFunctionBase.h>

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

Detailed Description

template<class TInput, class TOutput>
class itk::FunctionBase< TInput, TOutput >

Base class for all ITK function objects.

FunctionBase is the base class for ITK function objects. Specifically, the abstract method Evaluate() maps a point from the input space to a point in the output space.

Subclasses must override Evaluate().

This class is template over the input (domain) type and the output (range) type.

Definition at line 44 of file itkFunctionBase.h.

Public Types

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
 
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
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () 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
 

Protected Member Functions

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

 FunctionBase (const Self &)
 
void operator= (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)
 
- 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<class TInput, class TOutput>
typedef SmartPointer< const Self > itk::FunctionBase< TInput, TOutput >::ConstPointer

Definition at line 52 of file itkFunctionBase.h.

template<class TInput, class TOutput>
typedef TInput itk::FunctionBase< TInput, TOutput >::InputType

Input type

Definition at line 55 of file itkFunctionBase.h.

template<class TInput, class TOutput>
typedef TOutput itk::FunctionBase< TInput, TOutput >::OutputType

Output type

Definition at line 61 of file itkFunctionBase.h.

template<class TInput, class TOutput>
typedef SmartPointer< Self > itk::FunctionBase< TInput, TOutput >::Pointer

Definition at line 51 of file itkFunctionBase.h.

template<class TInput, class TOutput>
typedef FunctionBase itk::FunctionBase< TInput, TOutput >::Self

Standard class typedefs.

Definition at line 49 of file itkFunctionBase.h.

template<class TInput, class TOutput>
typedef Object itk::FunctionBase< TInput, TOutput >::Superclass

Definition at line 50 of file itkFunctionBase.h.

Constructor & Destructor Documentation

template<class TInput, class TOutput>
itk::FunctionBase< TInput, TOutput >::FunctionBase ( )
inlineprotected

Definition at line 67 of file itkFunctionBase.h.

template<class TInput, class TOutput>
itk::FunctionBase< TInput, TOutput >::~FunctionBase ( )
inlineprotected

Definition at line 68 of file itkFunctionBase.h.

template<class TInput, class TOutput>
itk::FunctionBase< TInput, TOutput >::FunctionBase ( const Self )
private

Member Function Documentation

template<class TInput, class TOutput>
virtual OutputType itk::FunctionBase< TInput, TOutput >::Evaluate ( const InputType input) const
pure virtual

Evaluate at the specified input position

Implemented in itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::ImageFunction< TInputImage, TOutput, TCoordRep >, itk::ImageFunction< TInputImage, TOutputType, TCoordRep >, itk::ImageFunction< TInputImage, SymmetricSecondRankTensor< TOutput, TInputImage::ImageDimension >, TOutput >, itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >, itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >, itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >, itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >, itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, TInputImage::ImageDimension >, TCoordRep >, itk::ImageFunction< TInputImage, TOutput >, itk::ImageFunction< TInputImage, bool, TCoordRep >, itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >, itk::ImageFunction< TInputImage, TOutput, TOutput >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, itk::InterpolateImageFunction< TImageType, TCoordRep >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >, itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::DistanceMetric< ParameterType >, itk::Statistics::MembershipFunctionBase< TVector >, itk::Statistics::MembershipFunctionBase< TMeasurementVector >, itk::HeavisideStepFunction< TInput, TOutput >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::SinRegularizedHeavisideStepFunction< TInput, TOutput >, itk::HeavisideStepFunctionBase< TInput, TOutput >, itk::SpatialFunction< TOutput, VImageDimension, TInput >, itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >, itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >, itk::SpatialFunction< bool, VDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaborKernelFunction< TRealValueType >, itk::BSplineDerivativeKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineKernelFunction< VSplineOrder, TRealValueType >, itk::Statistics::SigmoidTransferFunction< ScalarType >, itk::GaussianKernelFunction< TRealValueType >, itk::KernelFunctionBase< TRealValueType >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::GaussianKernelFunction< double >, itk::KernelFunctionBase< double >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< ParameterType >, itk::Statistics::EuclideanSquareDistanceMetric< TVector >, itk::Statistics::SquaredDifferenceErrorFunction< TMeasurementVector, ScalarType >, itk::Statistics::TransferFunctionBase< ScalarType >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::MeanSquaredErrorFunction< TMeasurementVector, ScalarType >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, ScalarType >, itk::Statistics::InputFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::NNetDistanceMetricBase< TMeasurementVector >, itk::Statistics::InputFunctionBase< TMeasurementVector, ScalarType >, itk::Statistics::GaussianRadialBasisFunction< ScalarType >, itk::Statistics::ProductInputFunction< TMeasurementVector, ScalarType >, itk::Statistics::SumInputFunction< TMeasurementVector, ScalarType >, itk::Statistics::IdentityTransferFunction< ScalarType >, itk::Statistics::RadialBasisFunctionBase< ScalarType >, itk::Statistics::TanHTransferFunction< ScalarType >, itk::Statistics::LogSigmoidTransferFunction< ScalarType >, itk::Statistics::MultiquadricRadialBasisFunction< ScalarType >, itk::Statistics::SignedHardLimitTransferFunction< ScalarType >, itk::Statistics::SymmetricSigmoidTransferFunction< ScalarType >, itk::Statistics::TanSigmoidTransferFunction< ScalarType >, itk::Statistics::GaussianTransferFunction< ScalarType >, and itk::Statistics::HardLimitTransferFunction< ScalarType >.

template<class TInput, class TOutput>
virtual const char* itk::FunctionBase< TInput, TOutput >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >, itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >, itk::PointSetFunction< TPointSet, TOutput, TCoordRep >, itk::ImageFunction< TInputImage, TOutput, TCoordRep >, itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::ImageFunction< TInputImage, TOutputType, TCoordRep >, itk::ImageFunction< TInputImage, SymmetricSecondRankTensor< TOutput, TInputImage::ImageDimension >, TOutput >, itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >, itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >, itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >, itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >, itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, TInputImage::ImageDimension >, TCoordRep >, itk::ImageFunction< TInputImage, TOutput >, itk::ImageFunction< TInputImage, bool, TCoordRep >, itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >, itk::ImageFunction< TInputImage, TOutput, TOutput >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::HeavisideStepFunction< TInput, TOutput >, itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::DiscreteHessianGaussianImageFunction< TInputImage, TOutput >, itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >, itk::Statistics::MembershipFunctionBase< TVector >, itk::Statistics::MembershipFunctionBase< TMeasurementVector >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::DiscreteGaussianDerivativeImageFunction< TInputImage, TOutput >, itk::DiscreteGradientMagnitudeGaussianImageFunction< TInputImage, TOutput >, itk::Statistics::DistanceMetric< ParameterType >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::AtanRegularizedHeavisideStepFunction< TInput, TOutput >, itk::SinRegularizedHeavisideStepFunction< TInput, TOutput >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::HeavisideStepFunctionBase< TInput, TOutput >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::GaborKernelFunction< TRealValueType >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >, itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, itk::QuadEdgeMeshBoundaryEdgesMeshFunction< TMesh >, itk::InterpolateImageFunction< TImageType, TCoordRep >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::SpatialFunction< TOutput, VImageDimension, TInput >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >, itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >, itk::SpatialFunction< bool, VDimension, TInput >, itk::BSplineDerivativeKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineKernelFunction< VSplineOrder, TRealValueType >, itk::KernelFunctionBase< TRealValueType >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::KernelFunctionBase< double >, itk::GaussianKernelFunction< TRealValueType >, itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianKernelFunction< double >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< ParameterType >, itk::Statistics::EuclideanSquareDistanceMetric< TVector >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::SquaredDifferenceErrorFunction< TMeasurementVector, ScalarType >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::Statistics::MeanSquaredErrorFunction< TMeasurementVector, ScalarType >, itk::KernelFunction, itk::Statistics::GaussianRadialBasisFunction< ScalarType >, itk::Statistics::ProductInputFunction< TMeasurementVector, ScalarType >, itk::Statistics::SumInputFunction< TMeasurementVector, ScalarType >, itk::Statistics::RadialBasisFunctionBase< ScalarType >, itk::Statistics::TransferFunctionBase< ScalarType >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::IdentityTransferFunction< ScalarType >, itk::Statistics::InputFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::LogSigmoidTransferFunction< ScalarType >, itk::Statistics::MultiquadricRadialBasisFunction< ScalarType >, itk::Statistics::NNetDistanceMetricBase< TMeasurementVector >, itk::Statistics::SigmoidTransferFunction< ScalarType >, itk::Statistics::SignedHardLimitTransferFunction< ScalarType >, itk::Statistics::SymmetricSigmoidTransferFunction< ScalarType >, itk::Statistics::TanHTransferFunction< ScalarType >, itk::Statistics::TanSigmoidTransferFunction< ScalarType >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, ScalarType >, itk::Statistics::InputFunctionBase< TMeasurementVector, ScalarType >, itk::Statistics::GaussianTransferFunction< ScalarType >, and itk::Statistics::HardLimitTransferFunction< ScalarType >.

template<class TInput, class TOutput>
void itk::FunctionBase< TInput, TOutput >::operator= ( const Self )
private

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