ITK  6.0.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>

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.

Definition at line 44 of file 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
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
const char * GetNameOfClass () const override
 
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) const
 
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
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Protected Member Functions

 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (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 val)
 
- 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 {}
 

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::GaussianKernelFunction< double >, itk::KernelFunctionBase< double >, itk::AtanRegularizedHeavisideStepFunction< TInput, TOutput >, itk::HeavisideStepFunction< TInput, TOutput >, itk::SinRegularizedHeavisideStepFunction< TInput, TOutput >, itk::HeavisideStepFunctionBase< float, double >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >, itk::SpatialFunction< TOutput, VImageDimension, TInput >, itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >, itk::SpatialFunction< bool, VDimension, Point< double, 3 > >, itk::SpatialFunction< double, 3, Point< double, 3 > >, itk::SpatialFunction< double, 3, Point< SpacePrecisionType, 3 > >, itk::SpatialFunction< bool, 3, Point< double, 3 > >, itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >, itk::QuadEdgeMeshBoundaryEdgesMeshFunction< TMesh >, itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, itk::Statistics::EuclideanSquareDistanceMetric< TVector >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::Statistics::DistanceMetric< TVector >, itk::Statistics::DistanceMetric< Array< double > >, itk::Statistics::MembershipFunctionBase< TVector >, itk::Statistics::MembershipFunctionBase< TMeasurementVector >, itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >, itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::BinaryThresholdImageFunction< TInputImage, float >, itk::BSplineInterpolateImageFunction< TImageType, float, TImageType::PixelType >, itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >, itk::CovarianceImageFunction< TInputImage, TCoordRep >, itk::ExtrapolateImageFunction< TInputImage, TCoordRep >, itk::ExtrapolateImageFunction< TInputImage, float >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::InterpolateImageFunction< TImageType, float >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::MeanImageFunction< TInputImage, TCoordRep >, itk::MedianImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >, itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >, itk::VarianceImageFunction< TInputImage, TCoordRep >, itk::VectorInterpolateImageFunction< TInputImage, float >, itk::VectorMeanImageFunction< TInputImage, TCoordRep >, itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::ImageFunction< TInputImage, TOutput, TCoordRep >, itk::ImageFunction< TImageType, NumericTraits< TInputImage::PixelType >::RealType, float >, itk::ImageFunction< TInputImage, bool, float >, itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >, itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, float >, itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >, itk::ImageFunction< TInputImage, double >, itk::ImageFunction< TInputImage, TInputImage::PixelType, float >, itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >, itk::GaborKernelFunction< TRealValueType >, and itk::KernelFunctionBase< TRealValueType >.

◆ GetNameOfClass()

template<typename TInput , typename TOutput >
const char * itk::FunctionBase< TInput, TOutput >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::GaussianKernelFunction< double >, itk::HeavisideStepFunctionBase< float, double >, itk::InteriorExteriorSpatialFunction< 3, Point< double, 3 > >, itk::KernelFunctionBase< double >, itk::KernelFunctionBase< TRealValueType >, itk::SpatialFunction< bool, TFunction::ImageDimension, TFunction::InputType >, itk::SpatialFunction< bool, VDimension, Point< double, 3 > >, itk::SpatialFunction< double, 3, Point< double, 3 > >, itk::SpatialFunction< double, 3, Point< SpacePrecisionType, 3 > >, itk::SpatialFunction< bool, 3, Point< double, 3 > >, itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >, itk::BinaryThresholdImageFunction< TInputImage, float >, itk::BSplineInterpolateImageFunction< TImageType, float, TImageType::PixelType >, itk::ExtrapolateImageFunction< TInputImage, float >, itk::GaussianInterpolateImageFunction< TInputImage, double >, itk::ImageFunction< TInputImage, TInputImage::PixelType, double >, itk::ImageFunction< TImageType, NumericTraits< TInputImage::PixelType >::RealType, double >, itk::ImageFunction< TImageType, NumericTraits< TInputImage::PixelType >::RealType, float >, itk::ImageFunction< TInputImage, bool, float >, itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >, itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, float >, itk::ImageFunction< TInputImage, double, double >, itk::ImageFunction< TInputImage, SymmetricSecondRankTensor< double, TInputImage::ImageDimension >, double >, itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >, itk::ImageFunction< TInputImage, double >, itk::ImageFunction< TInputImage, Vector< double, TInputImage::ImageDimension >, double >, itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >, itk::ImageFunction< TInputImage, TInputImage::PixelType, float >, itk::InterpolateImageFunction< TImageType, double >, itk::InterpolateImageFunction< TImageType, float >, itk::InterpolateImageFunction< TInputImage, double >, itk::VectorInterpolateImageFunction< TInputImage, double >, itk::VectorInterpolateImageFunction< TInputImage, float >, itk::Statistics::DistanceMetric< Array< double > >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, itk::Statistics::MembershipFunctionBase< TMeasurementVector >, and itk::PointSetFunction< TPointSet, double, double >.


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