Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itkNormalVectorFunctionBase.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkNormalVectorFunctionBase.h,v $
00005   Language:  C++
00006   Date:      $Date: 2003/09/10 14:28:53 $
00007   Version:   $Revision: 1.5 $
00008 
00009   Copyright (c) Insight Software Consortium. All rights reserved.
00010   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
00011 
00012      This software is distributed WITHOUT ANY WARRANTY; without even 
00013      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
00014      PURPOSE.  See the above copyright notices for more information.
00015 
00016      =========================================================================*/
00017 #ifndef __itkNormalVectorFunctionBase_h_
00018 #define __itkNormalVectorFunctionBase_h_
00019 
00020 #include "itkFiniteDifferenceSparseImageFunction.h"
00021 
00022 namespace itk {
00023 
00024 /*
00025  * \class NormalVectorFunctionBase
00026  *
00027  * \brief This class defines the common functionality for Sparse Image
00028  * neighborhoods of unit vectors.
00029  *
00030  * \par
00031  * This class is derived from the FiniteDifferenceSparseImageFunction class and
00032  * adds the functionality needed to process unit normal vector
00033  * neighborhoods.
00034  *
00035  * \par
00036  * This class is the parent class of the NormalVectorDiffusionFunction
00037  * class which defines all the necessary functionality for performing diffusion
00038  * operations on unit vectors stored in sparse images. Other (non-diffusion)
00039  * filters (such as median filtering) on unit vectors can also be derived from
00040  * this base class.
00041  *
00042  * \par PARAMETERS
00043  * This function class has a time step parameter which is returned by the
00044  * ComputeGloablTimeStep method. Unlike other finite difference function
00045  * classes, this class does not use the maximum change magnitude to compute the
00046  * time step, it returns this predetermined time step.
00047  */
00048 
00049 template <class TSparseImageType>
00050 class ITK_EXPORT NormalVectorFunctionBase
00051   :public FiniteDifferenceSparseImageFunction<TSparseImageType>
00052 {
00053 public:
00055   typedef NormalVectorFunctionBase Self;
00056   typedef FiniteDifferenceSparseImageFunction<TSparseImageType> Superclass;
00057   typedef SmartPointer<Self> Pointer;
00058   typedef SmartPointer<const Self> ConstPointer;
00059 
00061   itkTypeMacro( NormalVectorFunctionBase, FiniteDifferenceSparseImageFunction );
00062 
00064   itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);
00065 
00067   typedef typename Superclass::TimeStepType     TimeStepType;
00068   typedef typename Superclass::RadiusType       RadiusType;
00069   typedef typename Superclass::NeighborhoodType NeighborhoodType;
00070   typedef typename Superclass::FloatOffsetType  FloatOffsetType;
00071   typedef typename Superclass::IndexType        IndexType;
00072   typedef typename Superclass::SparseImageType  SparseImageType;
00073 
00075   typedef typename SparseImageType::NodeType NodeType;
00076 
00078   typedef typename NodeType::NodeValueType NodeValueType;
00079 
00081   typedef typename NodeType::NodeDataType NormalVectorType;
00082 
00084   virtual void *GetGlobalDataPointer() const {return 0;}
00085   virtual void ReleaseGlobalDataPointer( void* ) const {};
00087 
00089   virtual TimeStepType ComputeGlobalTimeStep( void* ) const
00090   { return m_TimeStep; }
00091 
00093   void SetTimeStep( const TimeStepType &ts )
00094   { m_TimeStep = ts; }
00095 
00097   TimeStepType GetTimeStep() const
00098   { return m_TimeStep; } 
00099 
00100 protected:
00101   NormalVectorFunctionBase();
00102   ~NormalVectorFunctionBase() {}
00103   virtual void PrintSelf(std::ostream& os, Indent indent) const;
00104 
00105 private:
00107   TimeStepType m_TimeStep;
00108 
00109   NormalVectorFunctionBase(const Self&); //purposely not implemented
00110   void operator=(const Self&);           //purposely not implemented
00111 };
00112 
00113 } // end namespace itk
00114 
00115 #ifndef ITK_MANUAL_INSTANTIATION
00116 #include "itkNormalVectorFunctionBase.txx"
00117 #endif
00118 
00119 #endif
00120 

Generated at Tue Jul 29 21:34:16 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000