ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes
itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkVectorCentralDifferenceImageFunction.h>

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

List of all members.

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

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int Dimension = InputPixelType::Dimension
static const unsigned int ImageDimension = TInputImage::ImageDimension

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

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:

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
template<class TInputImage , class TCoordRep = float>
typedef Superclass::ContinuousIndexType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::ContinuousIndexType
template<class TInputImage , class TCoordRep = float>
typedef Superclass::IndexType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::IndexType
template<class TInputImage , class TCoordRep = float>
typedef TInputImage itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputImageType
template<class TInputImage , class TCoordRep = float>
typedef TInputImage::PixelType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::InputPixelType
template<class TInputImage , class TCoordRep = float>
typedef Superclass::OutputType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::OutputType
template<class TInputImage , class TCoordRep = float>
typedef SmartPointer< Self > itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Pointer
template<class TInputImage , class TCoordRep = float>
typedef Superclass::PointType itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::PointType
template<class TInputImage , class TCoordRep = float>
typedef VectorCentralDifferenceImageFunction itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Self
template<class TInputImage , class TCoordRep = float>
typedef ImageFunction< TInputImage, Matrix< double, itkGetStaticConstMacro(Dimension), itkGetStaticConstMacro(ImageDimension) >, TCoordRep > itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::Superclass

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 ( ) [inline, 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.

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 [inline, virtual]

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 [inline, virtual]

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]
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]
template<class TInputImage , class TCoordRep = float>
void itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, 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.

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.


Member Data Documentation

template<class TInputImage , class 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 72 of file itkVectorCentralDifferenceImageFunction.h.

template<class TInputImage , class TCoordRep = float>
const unsigned int itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension [static]
template<class TInputImage , class TCoordRep = float>
bool itk::VectorCentralDifferenceImageFunction< TInputImage, TCoordRep >::m_UseImageDirection [private]

Definition at line 170 of file itkVectorCentralDifferenceImageFunction.h.


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