ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep > Class Template Referenceabstract

#include <itkPointSetFunction.h>

+ Inheritance diagram for itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >:
+ Collaboration diagram for itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = TCoordRep
 
using InputPixelType = typename InputPointSetType::PixelType
 
using InputPointSetConstPointer = typename InputPointSetType::ConstPointer
 
using InputPointSetType = TInputPointSet
 
using InputPointType = typename InputPointSetType::PointType
 
using OutputType = TOutput
 
using Pointer = SmartPointer< Self >
 
using Self = PointSetFunction
 
using Superclass = FunctionBase< typename TInputPointSet::PointType, TOutput >
 
- Public Types inherited from itk::FunctionBase< TInputPointSet::PointType, TOutput >
using ConstPointer = SmartPointer< const Self >
 
using InputType = TInputPointSet::PointType
 
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

TOutput Evaluate (const InputPointType &point) const override=0
 
const InputPointSetTypeGetInputPointSet () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetInputPointSet (const InputPointSetType *ptr)
 
- Public Member Functions inherited from itk::FunctionBase< TInputPointSet::PointType, TOutput >
virtual OutputType Evaluate (const InputType &input) const=0
 
- 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
 

Static Public Attributes

static constexpr unsigned int Dimension = TInputPointSet::PointDimension
 

Protected Member Functions

 PointSetFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PointSetFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< TInputPointSet::PointType, TOutput >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () 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 ()
 

Protected Attributes

InputPointSetConstPointer m_PointSet
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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 ()
 

Detailed Description

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
class itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >

Evaluates a function of an image at specified position.

FIXME: Documentation was copy-pasted from ImageFunction.

PointSetFunction is a baseclass for all objects that evaluates a function of an image at index, continuous index or point. This class is templated over the input image type, the type of the function output and the coordinate representation type (e.g. float or double).

The input image is set via method SetInputPointSet(). Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluates the function at an geometric point, image index and continuous image index.

Warning
Image BufferedRegion information is cached during in SetInputPointSet( image ). If the image BufferedRegion has changed one must call SetInputPointSet( image ) again to update the cache to the current values.
See also
Point
Index
ContinuousIndex

Definition at line 56 of file itkPointSetFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkPointSetFunction.h.

◆ CoordRepType

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::CoordRepType = TCoordRep

CoordRepType type alias support

Definition at line 87 of file itkPointSetFunction.h.

◆ InputPixelType

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPixelType = typename InputPointSetType::PixelType

Definition at line 78 of file itkPointSetFunction.h.

◆ InputPointSetConstPointer

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPointSetConstPointer = typename InputPointSetType::ConstPointer

InputPointSetPointer type alias support

Definition at line 81 of file itkPointSetFunction.h.

◆ InputPointSetType

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPointSetType = TInputPointSet

InputPointSetType type alias support

Definition at line 74 of file itkPointSetFunction.h.

◆ InputPointType

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::InputPointType = typename InputPointSetType::PointType

InputPixel type alias support

Definition at line 77 of file itkPointSetFunction.h.

◆ OutputType

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::OutputType = TOutput

OutputType type alias support

Definition at line 84 of file itkPointSetFunction.h.

◆ Pointer

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 67 of file itkPointSetFunction.h.

◆ Self

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Self = PointSetFunction

Standard class type aliases.

Definition at line 65 of file itkPointSetFunction.h.

◆ Superclass

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
using itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Superclass = FunctionBase<typename TInputPointSet::PointType, TOutput>

Definition at line 66 of file itkPointSetFunction.h.

Constructor & Destructor Documentation

◆ PointSetFunction()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PointSetFunction ( )
protected

◆ ~PointSetFunction()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::~PointSetFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
TOutput itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Evaluate ( const InputPointType point) const
overridepure virtual

Evaluate the function at specified Point position. Subclasses must provide this method.

◆ GetInputPointSet()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
const InputPointSetType* itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::GetInputPointSet ( ) const
inline

Get the input image.

Definition at line 98 of file itkPointSetFunction.h.

◆ GetNameOfClass()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
virtual const char* itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::FunctionBase< TInputPointSet::PointType, TOutput >.

◆ PrintSelf()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
void itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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.

◆ SetInputPointSet()

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
virtual void itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::SetInputPointSet ( const InputPointSetType ptr)
virtual

Set the input point set.

Warning
this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputPointSet again to update cached values.

Member Data Documentation

◆ Dimension

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
constexpr unsigned int itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::Dimension = TInputPointSet::PointDimension
staticconstexpr

Dimension underlying input point set.

Definition at line 62 of file itkPointSetFunction.h.

◆ m_PointSet

template<typename TInputPointSet, typename TOutput, typename TCoordRep = float>
InputPointSetConstPointer itk::PointSetFunction< TInputPointSet, TOutput, TCoordRep >::m_PointSet
protected

Const pointer to the input image.

Definition at line 115 of file itkPointSetFunction.h.


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