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

itkFiniteDifferenceFunction.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkFiniteDifferenceFunction.h,v $
00005   Language:  C++
00006   Date:      $Date: 2004/02/28 00:06:50 $
00007   Version:   $Revision: 1.15 $
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 __itkFiniteDifferenceFunction_h_
00018 #define __itkFiniteDifferenceFunction_h_
00019 
00020 #include "itkLightObject.h"
00021 #include "itkConstNeighborhoodIterator.h"
00022 #include "itkZeroFluxNeumannBoundaryCondition.h"
00023 #include "itkVector.h"
00024 #include "itkFixedArray.h"
00025 
00026 namespace itk {
00027 
00064 template<class TImageType>
00065 class ITK_EXPORT FiniteDifferenceFunction : public LightObject
00066 {
00067 public:
00068 
00070   typedef FiniteDifferenceFunction Self;
00071   typedef LightObject Superclass;
00072 
00073   typedef SmartPointer<Self> Pointer;
00074   typedef SmartPointer<const Self> ConstPointer;
00075 
00077   itkTypeMacro( FiniteDifferenceFunction, LightObject );
00078 
00080   typedef TImageType ImageType;
00081   typedef typename ImageType::PixelType       PixelType;
00082   typedef double PixelRealType;
00083 
00085   itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);
00086 
00088   typedef double  TimeStepType;
00089 
00092   typedef ZeroFluxNeumannBoundaryCondition<ImageType>
00093     DefaultBoundaryConditionType;
00094 
00096   typedef typename ConstNeighborhoodIterator<TImageType>::RadiusType RadiusType;
00097 
00100   typedef ConstNeighborhoodIterator<TImageType, DefaultBoundaryConditionType> NeighborhoodType;
00101 
00104   typedef Vector<float,itkGetStaticConstMacro(ImageDimension)> FloatOffsetType;
00105 
00115   virtual void InitializeIteration() {};
00116 
00130   virtual PixelType  ComputeUpdate(const NeighborhoodType &neighborhood,
00131                                    void *globalData,
00132                                    const FloatOffsetType &offset = FloatOffsetType(0.0)) = 0;
00133 
00134 
00137   void SetRadius(const RadiusType &r)
00138     { m_Radius = r; }
00139 
00142   const RadiusType &GetRadius() const
00143     { return m_Radius; }
00144 
00148   void SetScaleCoefficients (PixelRealType vals[ImageDimension])
00149     {
00150       for (unsigned int i = 0; i < ImageDimension; i++)
00151         {
00152         m_ScaleCoefficients[i] = vals[i];
00153         }
00154     }
00156 
00163   virtual TimeStepType ComputeGlobalTimeStep(void *GlobalData) const =0;
00164 
00172   virtual void *GetGlobalDataPointer() const =0;
00173 
00179   virtual void ReleaseGlobalDataPointer(void *GlobalData) const =0;
00180 
00181 protected:
00182   FiniteDifferenceFunction() 
00183   {
00184     // initialize variables
00185     m_Radius.Fill( 0 );
00186     for (unsigned int i = 0; i < ImageDimension; i++)
00187       {
00188       m_ScaleCoefficients[i] = 1.0;
00189       }
00190   }
00191   ~FiniteDifferenceFunction() {}
00192   void PrintSelf(std::ostream& os, Indent indent) const;
00193 
00194   RadiusType m_Radius;
00195   PixelRealType m_ScaleCoefficients[ImageDimension];
00196 
00197 private:
00198   FiniteDifferenceFunction(const Self&); //purposely not implemented
00199   void operator=(const Self&); //purposely not implemented
00200 };
00201   
00202 } // end namespace itk
00203 
00204 #ifndef ITK_MANUAL_INSTANTIATION
00205 #include "itkFiniteDifferenceFunction.txx"
00206 #endif
00207 
00208 #endif
00209 

Generated at Fri Sep 8 03:04:13 2006 for ITK by doxygen 1.4.7 written by Dimitri van Heesch, © 1997-2000