#include <itkCentralDifferenceImageFunction.h>

Inheritance diagram for itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >:

Collaboration diagram for itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >:

Detailed Description

template<typename TInputImage, typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>
class itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >

Calculate the derivative by central differencing.

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

This class supports both scalar and vector pixel types for the input image, including VectorImage types.

For vector-pixel image types, the TOutputType template parameter must be set to a vector of appropriate size, to accomadate a result for each pixel component in each dimension. The output is packed by pixel component, i.e.

[C0D0, C0D1, ..., C0DN, C1D0, ...]

where C = pixel component, and D = image dimension.

The output type can be, for example:

CovariantVector<double, numberOfPixelComponents * ImageDimension>

or

Matrix<double, numberOfPixelComponents, ImageDimension>

Possible improvements:

1) speed performance: The template-specialization of the Evaluate*() methods (needed to support vector-pixel types) incur a performance penalty for the scalar-pixel case, when compared with previous scalar-only versions of the code. On MacOS (2.4GHz Core 2 Duo, gcc 4.2) the penalty is 0.5-2%, depending on the method. To recover this loss, the specialization of the methods would have to be done such that a nested subroutine need not be called, ie the specialization is performed on the Evaluate* methods directly. At the moment is seems this can't be done without requiring a template parameter on the methods.

2) the use of Neighborhood operators may improve efficiency.

Definition at line 78 of file itkCentralDifferenceImageFunction.h.

Classes
struct	OutputTypeSpecializationStructType

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ContinuousIndexType	ContinuousIndexType

typedef Superclass::IndexType	IndexType

typedef TInputImage	InputImageType

typedef DefaultConvertPixelTraits < InputPixelType >	InputPixelConvertType

typedef InputImageType::PixelType	InputPixelType

typedef InterpolatorType::Pointer	InterpolatorPointer

typedef InterpolateImageFunction < TInputImage, TCoordRep >	InterpolatorType

typedef DefaultConvertPixelTraits < OutputType >	OutputConvertType

typedef Superclass::OutputType	OutputType

typedef OutputConvertType::ComponentType	OutputValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef CovariantVector < OutputValueType, itkGetStaticConstMacro(ImageDimension) >	ScalarDerivativeType

typedef CentralDifferenceImageFunction	Self

typedef TInputImage::SpacingType	SpacingType

typedef ImageFunction < TInputImage, TOutputType, TCoordRep >	Superclass

Public Types inherited from itk::ImageFunction< TInputImage, TOutputType, 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 TOutputType	OutputType

typedef SmartPointer< Self >	Pointer

typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) >	PointType

typedef ImageFunction	Self

typedef FunctionBase< Point < TCoordRep, itkGetStaticConstMacro(ImageDimension) > , TOutputType >	Superclass

Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TOutputType >
typedef SmartPointer< const Self >	ConstPointer

typedef Point< TCoordRep, TInputImage::ImageDimension >	InputType

typedef TOutputType	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 OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override

virtual OutputType	EvaluateAtIndex (const IndexType &index) const override

virtual const InterpolatorType *	GetInterpolator () const

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const char *	GetNameOfClass () const

virtual void	SetInputImage (const TInputImage *inputData) override

virtual void	SetInterpolator (InterpolatorType *interpolator)


virtual void	SetUseImageDirection (bool _arg)

virtual bool	GetUseImageDirection () const

virtual void	UseImageDirectionOn ()

virtual void	UseImageDirectionOff ()

Public Member Functions inherited from itk::ImageFunction< TInputImage, TOutputType, 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 TOutputType	Evaluate (const PointType &point) const override=0

virtual TOutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0

virtual TOutputType	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 >, TOutputType >
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, TOutputType, TCoordRep >
static const unsigned int	ImageDimension

Protected Member Functions
	CentralDifferenceImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~CentralDifferenceImageFunction () override

Protected Member Functions inherited from itk::ImageFunction< TInputImage, TOutputType, TCoordRep >
	ImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageFunction () override

Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TOutputType >
	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 Member Functions

template<typename Type >
void	EvaluateAtIndexSpecialized (const IndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< OutputType >) const

template<typename Type >
void	EvaluateAtIndexSpecialized (const IndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const


template<typename Type >
void	EvaluateAtContinuousIndexSpecialized (const ContinuousIndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< OutputType >) const

template<typename Type >
void	EvaluateAtContinuousIndexSpecialized (const ContinuousIndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const


template<typename Type >
void	EvaluateSpecialized (const PointType &point, OutputType &derivative, OutputTypeSpecializationStructType< OutputType >) const

template<typename Type >
void	EvaluateSpecialized (const PointType &point, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const

Private Attributes
InterpolatorPointer	m_Interpolator

bool	m_UseImageDirection

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, TOutputType, 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<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

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

Definition at line 95 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef Superclass::ContinuousIndexType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 128 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef Superclass::IndexType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::IndexType

Index typedef support.

Definition at line 125 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef TInputImage itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InputImageType

InputImageType typedef support.

Definition at line 101 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef DefaultConvertPixelTraits< InputPixelType > itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InputPixelConvertType

InputPixelConvert typedef support

Definition at line 110 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef InputImageType::PixelType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InputPixelType

InputPixelType typedef support

Definition at line 107 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef InterpolatorType::Pointer itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InterpolatorPointer

Definition at line 138 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef InterpolateImageFunction< TInputImage, TCoordRep > itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InterpolatorType

Interpolator typedef support.

Definition at line 137 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef DefaultConvertPixelTraits<OutputType> itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::OutputConvertType

Output convert typedef support

Definition at line 116 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef Superclass::OutputType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::OutputType

OutputType typdef support.

Definition at line 113 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef OutputConvertType::ComponentType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::OutputValueType

Output value typedef support

Definition at line 119 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef SmartPointer< Self > itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Pointer

Definition at line 94 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef Superclass::PointType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::PointType

Point typedef support.

Definition at line 131 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef CovariantVector<OutputValueType, itkGetStaticConstMacro(ImageDimension) > itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::ScalarDerivativeType

Scalar derivative typedef support

Definition at line 122 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef CentralDifferenceImageFunction itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Self

Standard class typedefs.

Definition at line 90 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef TInputImage::SpacingType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SpacingType

Spacing typedef support.

Definition at line 134 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

typedef ImageFunction< TInputImage, TOutputType, TCoordRep > itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Superclass

Definition at line 93 of file itkCentralDifferenceImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::CentralDifferenceImageFunction ( )

protected

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::~CentralDifferenceImageFunction ( )

inlineoverrideprotected

Definition at line 211 of file itkCentralDifferenceImageFunction.h.

Member Function Documentation

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual::itk::LightObject::Pointer itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

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

overridevirtual

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

No bounds checking is done. The point is assumed to lie within the image buffer. If not, 0 is returned for the derivative without any error return, because of bounds-checking performed on the neighboring points.

If point lies on a boundary in a given dimension, 0 is returned for that dimension. Note that points are centered on the voxel.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

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

overridevirtual

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

No bounds checking is done. The point is assumed to lie within the image buffer.

If cindex lies on a boundary in a given dimension, 0 is returned for that dimension.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

template<typename Type >

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtContinuousIndexSpecialized	(	const ContinuousIndexType &	index,
		OutputType &	derivative,
		OutputTypeSpecializationStructType< OutputType >
	)		const

inlineprivate

Specialized versions of EvaluteAtContinuousIndex() method to handle scalar or vector pixel types.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

template<typename Type >

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtContinuousIndexSpecialized	(	const ContinuousIndexType &	index,
		OutputType &	derivative,
		OutputTypeSpecializationStructType< Type >
	)		const

inlineprivate

Specialized versions of EvaluteAtContinuousIndex() method to handle scalar or vector pixel types.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

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

overridevirtual

Evalulate the image derivative by central differencing at specified index.

No bounds checking is done. The point is assumed to lie within the image buffer.

If index lies on a boundary in a given dimension, 0 is returned for that dimension.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

template<typename Type >

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtIndexSpecialized	(	const IndexType &	index,
		OutputType &	derivative,
		OutputTypeSpecializationStructType< OutputType >
	)		const

inlineprivate

Specialized versions of EvaluteAtIndex() method to handle scalar or vector pixel types.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

template<typename Type >

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtIndexSpecialized	(	const IndexType &	index,
		OutputType &	derivative,
		OutputTypeSpecializationStructType< Type >
	)		const

inlineprivate

Specialized versions of EvaluteAtIndex() method to handle scalar or vector pixel types.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

template<typename Type >

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateSpecialized	(	const PointType &	point,
		OutputType &	derivative,
		OutputTypeSpecializationStructType< OutputType >
	)		const

private

Specialized versions of Evalute() method to handle scalar or vector pixel types.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

template<typename Type >

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateSpecialized	(	const PointType &	point,
		OutputType &	derivative,
		OutputTypeSpecializationStructType< Type >
	)		const

private

Specialized versions of Evalute() method to handle scalar or vector pixel types.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual const InterpolatorType* itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::GetInterpolator ( ) const

virtual

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual InterpolatorType* itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::GetModifiableInterpolator ( )

virtual

Get the interpolator.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, TOutputType, TCoordRep >.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual bool itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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. For EvaluateAtIndex and EvaluateAtContinuousIndex, 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. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

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

static

Method for creation through the object factory.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SetInputImage ( const TInputImage * inputData )

overridevirtual

Set the input image. This must be set by the user.

Reimplemented from itk::ImageFunction< TInputImage, TOutputType, TCoordRep >.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SetInterpolator ( InterpolatorType * interpolator )

virtual

Set interpolator. The interpolator is used in the methods Evaluate and EvaluateAtContinuousIndex.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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. For EvaluateAtIndex and EvaluateAtContinuousIndex, 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. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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. For EvaluateAtIndex and EvaluateAtContinuousIndex, 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. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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. For EvaluateAtIndex and EvaluateAtContinuousIndex, 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. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

Member Data Documentation

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

const unsigned int itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::ImageDimension = TInputImage::ImageDimension

static

Dimension underlying input image.

Definition at line 87 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

InterpolatorPointer itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::m_Interpolator

private

Definition at line 252 of file itkCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>

bool itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::m_UseImageDirection

private

Definition at line 249 of file itkCentralDifferenceImageFunction.h.

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

itkCentralDifferenceImageFunction.h

Detailed Description

template<typename TInputImage, typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >> class itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename TInputImage, typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension >>
class itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >