ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkVectorCentralDifferenceImageFunction.h>

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

Detailed Description

template<typename TInputImage, typename 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:

Author
Tom Vercauteren, INRIA & Mauna Kea Technologies

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

Definition at line 48 of file itkVectorCentralDifferenceImageFunction.h.

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< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
- Public Types inherited from itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, TInputImage::ImageDimension >, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
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 Matrix< double,
TInputImage::PixelType::Dimension,
TInputImage::ImageDimension > 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, Matrix< double,
TInputImage::PixelType::Dimension,
TInputImage::ImageDimension > > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, Matrix< double, TInputImage::PixelType::Dimension, TInputImage::ImageDimension > >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef Matrix< double,
TInputImage::PixelType::Dimension,
TInputImage::ImageDimension > 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
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 char * GetNameOfClass () const
 
virtual void SetUseImageDirection (bool _arg)
 
virtual bool GetUseImageDirection () const
 
virtual void UseImageDirectionOn ()
 
virtual void UseImageDirectionOff ()
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, 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,
TInputImage::PixelType::Dimension,
TInputImage::ImageDimension > 
Evaluate (const PointType &point) const override=0
 
virtual Matrix< double,
TInputImage::PixelType::Dimension,
TInputImage::ImageDimension > 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual Matrix< double,
TInputImage::PixelType::Dimension,
TInputImage::ImageDimension > 
EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
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
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, Matrix< double, TInputImage::PixelType::Dimension, 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
 
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
 
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 Dimension = InputPixelType::Dimension
 
static const unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, TInputImage::ImageDimension >, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorCentralDifferenceImageFunction ()
 
 ~VectorCentralDifferenceImageFunction ()
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, 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 >, Matrix< double, TInputImage::PixelType::Dimension, 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

bool m_UseImageDirection
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, Matrix< double, TInputImage::PixelType::Dimension, 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<typename TInputImage , typename TCoordRep = float>
typedef SmartPointer< const Self > itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::ConstPointer

Standard class typedefs.

Definition at line 73 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::ContinuousIndexType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 92 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::IndexType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 89 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef TInputImage itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 80 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef TInputImage::PixelType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputPixelType

Definition at line 56 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::OutputType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typdef support.

Definition at line 86 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef SmartPointer< Self > itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Pointer

Standard class typedefs.

Definition at line 72 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::PointType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 95 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef VectorCentralDifferenceImageFunction itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 67 of file itkVectorCentralDifferenceImageFunction.h.

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

Standard class typedefs.

Definition at line 71 of file itkVectorCentralDifferenceImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = float>
itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::VectorCentralDifferenceImageFunction ( )
protected
template<typename TInputImage , typename TCoordRep = float>
itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::~VectorCentralDifferenceImageFunction ( )
inlineprotected

Definition at line 148 of file itkVectorCentralDifferenceImageFunction.h.

Member Function Documentation

template<typename TInputImage , typename TCoordRep = float>
virtual::itk::LightObject::Pointer itk::VectorCentralDifferenceImageFunction< 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<typename TInputImage , typename TCoordRep = float>
virtual OutputType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverridevirtual

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

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

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

Definition at line 114 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
virtual OutputType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlineoverridevirtual

Definition at line 122 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
virtual OutputType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
overridevirtual

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<typename TInputImage , typename TCoordRep = float>
virtual const char* itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual
template<typename TInputImage , typename 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<typename TInputImage , typename TCoordRep = float>
static Pointer itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TCoordRep = float>
void itk::VectorCentralDifferenceImageFunction< 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<typename TInputImage , typename 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<typename TInputImage , typename 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<typename TInputImage , typename 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.

Member Data Documentation

template<typename TInputImage , typename TCoordRep = float>
const unsigned int itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Dimension = InputPixelType::Dimension
static

Extract the vector dimension from the pixel template parameter.

Definition at line 60 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
const unsigned int itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension
static

Dimension underlying input image.

Definition at line 64 of file itkVectorCentralDifferenceImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
bool itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::m_UseImageDirection
private

Definition at line 152 of file itkVectorCentralDifferenceImageFunction.h.


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