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
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef Superclass::IndexType	IndexType
typedef TInputImage	InputImageType
typedef LinearInterpolateImageFunction < TInputImage, TCoordRep >	InterpolateImageFunctionType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef PhysicalCentralDifferenceImageFunction	Self
typedef ImageFunction < TInputImage, CovariantVector < double, itkGetStaticConstMacro(ImageDimension)> , TCoordRep >	Superclass
Public Types inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < TCoordRep, itkGetStaticConstMacro(ImageDimension) >	ContinuousIndexType
typedef TCoordRep	CoordRepType
typedef InputImageType::IndexType	IndexType
typedef InputImageType::IndexValueType	IndexValueType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef CovariantVector < double, TInputImage::ImageDimension >	OutputType
typedef SmartPointer< Self >	Pointer
typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) >	PointType
typedef ImageFunction	Self
typedef FunctionBase< Point < TCoordRep, itkGetStaticConstMacro(ImageDimension) > , CovariantVector< double, TInputImage::ImageDimension > >	Superclass
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer
typedef Point< TCoordRep, TInputImage::ImageDimension >	InputType
typedef CovariantVector < double, TInputImage::ImageDimension >	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 ::itk::LightObject::Pointer	CreateAnother () const
virtual OutputType	Evaluate (const PointType &point) const override
virtual const char *	GetNameOfClass () const
virtual void	SetInputImage (const InputImageType *ptr) override
virtual OutputType	EvaluateAtIndex (const IndexType &index) const override
virtual 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
virtual 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::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
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
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

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 const unsigned int	ImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, TCoordRep >
static const unsigned int	ImageDimension

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

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
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<class TInputImage , class TCoordRep = float>

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

Definition at line 62 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef Superclass::ContinuousIndexType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 80 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef Superclass::IndexType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 77 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef TInputImage itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 68 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef LinearInterpolateImageFunction<TInputImage, TCoordRep> itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::InterpolateImageFunctionType

Linear interpolate function typedef.

Definition at line 87 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef Superclass::OutputType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typdef support.

Definition at line 74 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef SmartPointer<Self> itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 61 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef Superclass::PointType itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 83 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef PhysicalCentralDifferenceImageFunction itk::PhysicalCentralDifferenceImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 56 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

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

inlineprotected

Definition at line 141 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>

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

overridevirtual

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>

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

inlineoverridevirtual

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 122 of file itkPhysicalCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

inlineoverridevirtual

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 108 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>

virtual 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 93 of file itkPhysicalCentralDifferenceImageFunction.h.

Member Data Documentation

template<class TInputImage , class TCoordRep = float>

const 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 145 of file itkPhysicalCentralDifferenceImageFunction.h.

---

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

• itkPhysicalCentralDifferenceImageFunction.h