ITK  5.2.0
Insight 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 >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputType = TInput
 
using OutputType = TOutput
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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 ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ ConstPointer

template<typename TInput, typename TOutput>
using itk::FunctionBase< TInput, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkFunctionBase.h.

◆ InputType

template<typename TInput, typename TOutput>
using itk::FunctionBase< TInput, TOutput >::InputType = TInput

Input type

Definition at line 59 of file itkFunctionBase.h.

◆ OutputType

template<typename TInput, typename TOutput>
using itk::FunctionBase< TInput, TOutput >::OutputType = TOutput

Output type

Definition at line 62 of file itkFunctionBase.h.

◆ Pointer

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

Definition at line 52 of file itkFunctionBase.h.

◆ Self

template<typename TInput, typename TOutput>
using itk::FunctionBase< TInput, TOutput >::Self = FunctionBase

Standard class type aliases.

Definition at line 50 of file itkFunctionBase.h.

◆ Superclass

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

Definition at line 51 of file itkFunctionBase.h.

Constructor & Destructor Documentation

◆ FunctionBase()

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

◆ ~FunctionBase()

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

Member Function Documentation

◆ Evaluate()

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::KernelFunctionBase< TRealValueType >, itk::GaborKernelFunction< TRealValueType >, itk::BSplineDerivativeKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineKernelFunction< VSplineOrder, TRealValueType >, itk::GaussianKernelFunction< TRealValueType >, itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, 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< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >, itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >, itk::ImageFunction< TInputImage, TOutput >, itk::ImageFunction< TInputImage, bool, TCoordRep >, itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >, itk::ImageFunction< TInputImage, TOutput, TOutput >, itk::InterpolateImageFunction< TImageType, TCoordRep >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::DistanceMetric< Array< double > >, itk::Statistics::MembershipFunctionBase< TVector >, itk::Statistics::MembershipFunctionBase< TMeasurementVector >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, itk::Statistics::EuclideanSquareDistanceMetric< TVector >, itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::InteriorExteriorSpatialFunction< 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::HeavisideStepFunction< TInput, TOutput >, itk::SinRegularizedHeavisideStepFunction< TInput, TOutput >, itk::KernelFunctionBase< double >, itk::GaussianKernelFunction< double >, and itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >.

Examples
Examples/Statistics/WeightedSampleStatistics.cxx.

◆ GetNameOfClass()

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::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >, itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >, itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::FrustumSpatialFunction< VDimension, TInput >, itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >, 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< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >, itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >, itk::ImageFunction< TInputImage, TOutput >, itk::ImageFunction< TInputImage, bool, TCoordRep >, itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >, itk::ImageFunction< TInputImage, TOutput, TOutput >, itk::HeavisideStepFunction< TInput, TOutput >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >, itk::PointSetFunction< TPointSet, TOutput, TCoordRep >, itk::Statistics::MembershipFunctionBase< TVector >, itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::MembershipFunctionBase< TMeasurementVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::DistanceMetric< Array< double > >, itk::AtanRegularizedHeavisideStepFunction< TInput, TOutput >, itk::GaussianDerivativeImageFunction< TInputImage, TOutput >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::DiscreteGradientMagnitudeGaussianImageFunction< TInputImage, TOutput >, itk::DiscreteHessianGaussianImageFunction< TInputImage, TOutput >, itk::HeavisideStepFunctionBase< TInput, TOutput >, itk::SinRegularizedHeavisideStepFunction< TInput, TOutput >, itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::GaborKernelFunction< TRealValueType >, itk::DiscreteGaussianDerivativeImageFunction< TInputImage, TOutput >, itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >, itk::InterpolateImageFunction< TInputImage, TCoordRep >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::InterpolateImageFunction< TImageType, TCoordRep >, itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >, itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::QuadEdgeMeshBoundaryEdgesMeshFunction< TMesh >, itk::BSplineDerivativeKernelFunction< VSplineOrder, TRealValueType >, itk::BSplineKernelFunction< VSplineOrder, TRealValueType >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >, itk::SpatialFunction< TOutput, VImageDimension, TInput >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >, itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >, itk::SpatialFunction< bool, VDimension, TInput >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::GaussianKernelFunction< TRealValueType >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianKernelFunction< double >, itk::KernelFunctionBase< TRealValueType >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::KernelFunctionBase< double >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::Statistics::EuclideanSquareDistanceMetric< TVector >, and itk::SphereSpatialFunction< VImageDimension, TInput >.


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