#include <itkVectorCentralDifferenceImageFunction.h>

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

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

Public Types
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef Superclass::IndexType	IndexType
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef Superclass::OutputType	OutputType
typedef Superclass::PointType	PointType

typedef VectorCentralDifferenceImageFunction	Self
typedef ImageFunction < TInputImage, Matrix< double, itkGetStaticConstMacro(Dimension), itkGetStaticConstMacro(ImageDimension) > , TCoordRep >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Types inherited from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >
typedef TCoordRep	CoordRepType
typedef InputImageType::IndexValueType	IndexValueType
typedef InputImageType::ConstPointer	InputImageConstPointer
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension > >
typedef Point< TCoordRep, TInputImage::ImageDimension >	InputType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual OutputType	Evaluate (const PointType &point) const
virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const
virtual OutputType	EvaluateAtIndex (const IndexType &index) const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< 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 Matrix< double,::itk::GetDimension < TInputImage::PixelType > ::Dimension,::itk::GetImageDimension < TInputImage > ::ImageDimension >	Evaluate (const PointType &point) const =0
virtual Matrix< double,::itk::GetDimension < TInputImage::PixelType > ::Dimension,::itk::GetImageDimension < TInputImage > ::ImageDimension >	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
virtual Matrix< double,::itk::GetDimension < TInputImage::PixelType > ::Dimension,::itk::GetImageDimension < TInputImage > ::ImageDimension >	EvaluateAtIndex (const IndexType &index) const =0
virtual const ContinuousIndexType &	GetEndContinuousIndex ()
virtual const IndexType &	GetEndIndex ()
const InputImageType *	GetInputImage () const
virtual const ContinuousIndexType &	GetStartContinuousIndex ()
virtual const IndexType &	GetStartIndex ()
virtual void	SetInputImage (const InputImageType *ptr)
virtual bool	IsInsideBuffer (const IndexType &index) const
virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const
virtual bool	IsInsideBuffer (const PointType &point) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	Dimension = InputPixelType::Dimension
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >
Protected Member Functions inherited from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >
	ImageFunction ()
	~ImageFunction ()
Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension > >
	FunctionBase ()
	~FunctionBase ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 Member Functions
void	operator= (const Self &)
	VectorCentralDifferenceImageFunction (const Self &)

Private Attributes
bool	m_UseImageDirection
virtual void	SetUseImageDirection (bool _arg)
virtual bool	GetUseImageDirection () const
virtual void	UseImageDirectionOn ()
virtual void	UseImageDirectionOff ()
	VectorCentralDifferenceImageFunction ()
	~VectorCentralDifferenceImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >
ContinuousIndexType	m_EndContinuousIndex
IndexType	m_EndIndex
InputImageConstPointer	m_Image
ContinuousIndexType	m_StartContinuousIndex
IndexType	m_StartIndex

Detailed Description

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

Calculate the derivative by central differencing.

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

Possible improvements:

the use of Neighborhood operators may improve efficiency.

Author:: Tom Vercauteren, INRIA & Mauna Kea Technologies

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/510

Definition at line 60 of file itkVectorCentralDifferenceImageFunction.h.

Member Typedef Documentation

template<class TInputImage , class TCoordRep = float>

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

Standard class typedefs.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 85 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

ContinuousIndex typedef support.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 104 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

Index typedef support.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 101 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

InputImageType typedef support.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 92 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef TInputImage::PixelType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputPixelType

InputPixel typedef support

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 68 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

OutputType typdef support.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 98 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

Standard class typedefs.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 84 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

Point typedef support.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 107 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

Standard class typedefs.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 79 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

typedef ImageFunction< TInputImage, Matrix< double, itkGetStaticConstMacro(Dimension), itkGetStaticConstMacro(ImageDimension) >, TCoordRep > itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Superclass

Standard class typedefs.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

Definition at line 83 of file itkVectorCentralDifferenceImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep = float>

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

protected

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TCoordRep = float>

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

inlineprotected

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Definition at line 158 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::VectorCentralDifferenceImageFunction ( const Self & )

private

Member Function Documentation

template<class TInputImage , class TCoordRep = float>

virtual::itk::LightObject::Pointer itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::CreateAnother ( void ) 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::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType & point ) const

inlinevirtual

Evalulate the image derivative by central differencing at non-integer positions.

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 the method.

Definition at line 126 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

inlinevirtual

Definition at line 134 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>

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

virtual

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 the method.

template<class TInputImage , class TCoordRep = float>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

template<class TInputImage , class TCoordRep = float>

virtual bool itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::GetUseImageDirection ( ) const

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TCoordRep = float>

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

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TCoordRep = float>

void itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::operator= ( const Self & )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

template<class TInputImage , class TCoordRep = float>

void itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Reimplemented from itk::ImageFunction< TInputImage, Matrix< double,::itk::GetDimension< TInputImage::PixelType >::Dimension,::itk::GetImageDimension< TInputImage >::ImageDimension >, TCoordRep >.

template<class TInputImage , class TCoordRep = float>

virtual void itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::SetUseImageDirection ( bool _arg )

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TCoordRep = float>

virtual void itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::UseImageDirectionOff ( )

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TCoordRep = float>

virtual void itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::UseImageDirectionOn ( )

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.