ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected 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<typename TInput, typename 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.

Examples:
Examples/Statistics/WeightedSampleStatistics.cxx.

Definition at line 44 of file itkFunctionBase.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef TInput InputType
 
typedef TOutput OutputType
 
typedef SmartPointer< Self > Pointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
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 override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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
 

Protected Member Functions

 FunctionBase ()
 
 ~FunctionBase () override
 
- 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 override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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 ()
 

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 ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInput, typename TOutput>
typedef SmartPointer< const Self > itk::FunctionBase< TInput, TOutput >::ConstPointer
template<typename TInput, typename TOutput>
typedef TInput itk::FunctionBase< TInput, TOutput >::InputType

Input type

Examples:
Examples/Statistics/WeightedSampleStatistics.cxx.

Definition at line 55 of file itkFunctionBase.h.

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

Output type

Examples:
Examples/Statistics/WeightedSampleStatistics.cxx.

Definition at line 61 of file itkFunctionBase.h.

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

Standard class typedefs.

Examples:
Examples/Statistics/WeightedSampleStatistics.cxx.

Definition at line 49 of file itkFunctionBase.h.

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

Constructor & Destructor Documentation

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

Definition at line 67 of file itkFunctionBase.h.

template<typename TInput, typename TOutput>
itk::FunctionBase< TInput, TOutput >::~FunctionBase ( )
inlineoverrideprotected

Definition at line 68 of file itkFunctionBase.h.

Member Function Documentation

template<typename TInput, typename 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::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >, itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::DistanceMetric< Array< double > >, 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::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, 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::GaborKernelFunction< TRealValueType >, itk::Statistics::SigmoidTransferFunction< TScalar >, itk::BSplineDerivativeKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineKernelFunction< VSplineOrder, TRealValueType >, itk::KernelFunctionBase< TRealValueType >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::KernelFunctionBase< double >, itk::GaussianKernelFunction< TRealValueType >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::GaussianKernelFunction< double >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, itk::Statistics::EuclideanSquareDistanceMetric< TVector >, itk::Statistics::SquaredDifferenceErrorFunction< TMeasurementVector, ScalarType >, itk::Statistics::TransferFunctionBase< ScalarType >, itk::Statistics::TransferFunctionBase< TScalar >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::MeanSquaredErrorFunction< TMeasurementVector, ScalarType >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, ScalarType >, itk::Statistics::InputFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::LogSigmoidTransferFunction< TScalar >, 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::MultiquadricRadialBasisFunction< ScalarType >, itk::Statistics::SignedHardLimitTransferFunction< ScalarType >, itk::Statistics::SymmetricSigmoidTransferFunction< ScalarType >, itk::Statistics::TanSigmoidTransferFunction< ScalarType >, itk::Statistics::GaussianTransferFunction< ScalarType >, and itk::Statistics::HardLimitTransferFunction< ScalarType >.

Examples:
Examples/Statistics/WeightedSampleStatistics.cxx.
template<typename TInput, typename 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::SiddonJacobsRayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, 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, CovariantVector< double, TInputImage::ImageDimension >, 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::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >, itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >, itk::PointSetFunction< TPointSet, TOutput, TCoordRep >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >, 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< Array< double > >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >, itk::GaussianDistanceKernel< TRealValueType >, itk::AtanRegularizedHeavisideStepFunction< TInput, TOutput >, itk::SinRegularizedHeavisideStepFunction< TInput, TOutput >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::HeavisideStepFunctionBase< TInput, TOutput >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::GaborKernelFunction< TRealValueType >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::InterpolateImageFunction< 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::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::SpatialFunction< TOutput, VImageDimension, TInput >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, 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::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::LabelImageGenericInterpolateImageFunction< TInputImage, TInterpolator, TCoordRep >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VDimension, TInput >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, 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::LogSigmoidTransferFunction< TScalar >, itk::Statistics::SigmoidTransferFunction< TScalar >, itk::Statistics::GaussianRadialBasisFunction< ScalarType >, itk::Statistics::ProductInputFunction< TMeasurementVector, ScalarType >, itk::Statistics::SumInputFunction< TMeasurementVector, ScalarType >, itk::Statistics::RadialBasisFunctionBase< ScalarType >, itk::Statistics::TransferFunctionBase< ScalarType >, itk::Statistics::TransferFunctionBase< TScalar >, itk::Statistics::ErrorFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::IdentityTransferFunction< ScalarType >, itk::Statistics::InputFunctionBase< TMeasurementVector, TTargetVector >, itk::Statistics::MultiquadricRadialBasisFunction< ScalarType >, itk::Statistics::NNetDistanceMetricBase< TMeasurementVector >, 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 >.


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