itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkPhysicalCentralDifferenceImageFunction.h>

Inheritance diagram for itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >:

Collaboration diagram for itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >:

Detailed Description

template<class TInputImage, class TCoordRep = float>
class itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >

Calculate the derivative by central differencing in physical space.

This class is templated over the input image type and the coordinate representation type (e.g. float or double).

Author

Dan Mueller, Queensland University of Technology, dan.muel[at]gmail.com

Definition at line 44 of file itkPhysicalCentralDifferenceImageFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	InputImageType = TInputImage
using	InterpolateImageFunctionType = LinearInterpolateImageFunction< TInputImage, TCoordRep >
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
using	Self = PhysicalCentralDifferenceImageFunction
using	Superclass = ImageFunction< TInputImage, CovariantVector< double, itkGetStaticConstMacro(ImageDimension)>, TCoordRep >
Public Types inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
using	CoordRepType = TCoordRep
using	IndexType = typename InputImageType::IndexType
using	IndexValueType = typename InputImageType::IndexValueType
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImageType = TInputImage
using	InputPixelType = typename InputImageType::PixelType
using	OutputType = CovariantVector< double, TInputImage::ImageDimension >
using	Pointer = SmartPointer< Self >
using	PointType = Point< TCoordRep, Self::ImageDimension >
using	Self = ImageFunction
using	Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
using	ConstPointer = SmartPointer< const Self >
using	InputType = Point< TCoordRep, TInputImage::ImageDimension >
using	OutputType = CovariantVector< double, TInputImage::ImageDimension >
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 ::itk::LightObject::Pointer	CreateAnother () const
OutputType	Evaluate (const PointType &point) const override
virtual const char *	GetNameOfClass () const
void	SetInputImage (const InputImageType *ptr) override
OutputType	EvaluateAtIndex (const IndexType &index) const override
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
Public Member Functions inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
CovariantVector< double, TInputImage::ImageDimension >	Evaluate (const PointType &point) const override=0
virtual CovariantVector < double, TInputImage::ImageDimension >	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
virtual CovariantVector < double, TInputImage::ImageDimension >	EvaluateAtIndex (const IndexType &index) const =0
virtual const ContinuousIndexType &	GetEndContinuousIndex () const
virtual const IndexType &	GetEndIndex () const
const InputImageType *	GetInputImage () const
virtual const ContinuousIndexType &	GetStartContinuousIndex () const
virtual const IndexType &	GetStartIndex () const
virtual bool	IsInsideBuffer (const IndexType &index) const
virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const
virtual bool	IsInsideBuffer (const PointType &point) const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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 Member Functions
static Pointer	New ()
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	PhysicalCentralDifferenceImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~PhysicalCentralDifferenceImageFunction () override
Protected Member Functions inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
	ImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageFunction () override=default
Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
	FunctionBase ()=default
	~FunctionBase () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()

Private Attributes
InterpolateImageFunctionType::Pointer	m_Interpolator

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
ContinuousIndexType	m_EndContinuousIndex
IndexType	m_EndIndex
InputImageConstPointer	m_Image
ContinuousIndexType	m_StartContinuousIndex
IndexType	m_StartIndex
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 62 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support.

Definition at line 80 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support.

Definition at line 77 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputImageType = TInputImage

InputImageType type alias support.

Definition at line 71 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::InterpolateImageFunctionType = LinearInterpolateImageFunction<TInputImage, TCoordRep>

Linear interpolate function type alias.

Definition at line 86 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::OutputType = typename Superclass::OutputType

OutputType typdef support.

Definition at line 74 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 61 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support.

Definition at line 83 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::Self = PhysicalCentralDifferenceImageFunction

Standard class type alias.

Definition at line 56 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

using itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, CovariantVector<double, itkGetStaticConstMacro(ImageDimension)>, TCoordRep>

Definition at line 60 of file itkPhysicalCentralDifferenceImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep = float>

itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::PhysicalCentralDifferenceImageFunction ( )

protected

template<class TInputImage , class TCoordRep = float>

itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::~PhysicalCentralDifferenceImageFunction ( )

inlineoverrideprotected

Definition at line 140 of file itkPhysicalCentralDifferenceImageFunction.h.

Member Function Documentation

template<class TInputImage , class TCoordRep = float>

virtual::itk::LightObject::Pointer itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TCoordRep = float>

OutputType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType &  point ) const

override

Evalulate the image derivative by central differencing at specified physical point.

No bounds checking is done. The point is assume to lie within the image buffer. ImageFunction::IsInsideBuffer() can be used to check bounds before calling this method.

template<class TInputImage , class TCoordRep = float>

OutputType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  cindex ) const

inlineoverride

Evalulate the image derivative by central differencing at specified continuous index.

No bounds checking is done. The point is assume to lie within the image buffer. ImageFunction::IsInsideBuffer() can be used to check bounds before calling this method.

Definition at line 121 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

OutputType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType &  index ) const

inlineoverride

Evalulate the image derivative by central differencing at specified index.

 No bounds checking is done. The point is assume to lie within the
 image buffer. ImageFunction::IsInsideBuffer() can be used to check
 bounds before calling this method.  

Definition at line 107 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

virtual const char* itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >.

template<class TInputImage , class TCoordRep = float>

static Pointer itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

template<class TInputImage , class TCoordRep = float>

void itk::PhysicalCentralDifferenceImageFunction< TInputImage, 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.

template<class TInputImage , class TCoordRep = float>

void itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::SetInputImage ( const InputImageType *  ptr )

inlineoverridevirtual

Set the input image.

Warning

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

Reimplemented from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >.

Definition at line 92 of file itkPhysicalCentralDifferenceImageFunction.h.

Member Data Documentation

template<class TInputImage , class TCoordRep = float>

constexpr unsigned int itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension

static

Dimension underlying input image.

Definition at line 53 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

InterpolateImageFunctionType::Pointer itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::m_Interpolator

private

Definition at line 144 of file itkPhysicalCentralDifferenceImageFunction.h.

---

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

• itkPhysicalCentralDifferenceImageFunction.h