itkFiniteDifferenceFunction.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFiniteDifferenceFunction.h,v $
  Language:  C++
  Date:      $Date: 2002/09/11 19:57:12 $
  Version:   $Revision: 1.7 $

  Copyright (c) 2002 Insight Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkFiniteDifferenceFunction_h_
#define __itkFiniteDifferenceFunction_h_

#include "itkLightObject.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkConstSmartNeighborhoodIterator.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"
#include "itkVector.h"

namespace itk {

template<class TImageType>
class FiniteDifferenceFunction : public LightObject
{
public:
  typedef FiniteDifferenceFunction Self;
  typedef LightObject Superclass;

  typedef SmartPointer<Self> Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  itkTypeMacro( FiniteDifferenceFunction, LightObject );

  typedef TImageType ImageType;
  typedef typename ImageType::PixelType       PixelType;
  
  itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);

  typedef double  TimeStepType;

  typedef ZeroFluxNeumannBoundaryCondition<ImageType>
    DefaultBoundaryConditionType;

  typedef typename ConstNeighborhoodIterator<TImageType>::RadiusType RadiusType;

  typedef ConstNeighborhoodIterator<TImageType> NeighborhoodType;

  typedef ConstSmartNeighborhoodIterator<TImageType,
    DefaultBoundaryConditionType> BoundaryNeighborhoodType;

  typedef Vector<float,itkGetStaticConstMacro(ImageDimension)> FloatOffsetType;
  
  virtual void InitializeIteration() {};

  virtual PixelType  ComputeUpdate(const NeighborhoodType &neighborhood,
                                   void *globalData,
                                   const FloatOffsetType &offset = m_ZeroOffset)
    const = 0;

  virtual PixelType  ComputeUpdate(const BoundaryNeighborhoodType
                                   &neighborhood, void *globalData,
                              const FloatOffsetType &offset = m_ZeroOffset)
                                  const = 0;

  void SetRadius(const RadiusType &r)
    { m_Radius = r; }

  const RadiusType &GetRadius() const
    { return m_Radius; }

  virtual TimeStepType ComputeGlobalTimeStep(void *GlobalData) const =0;

  virtual void *GetGlobalDataPointer() const =0;

  virtual void ReleaseGlobalDataPointer(void *GlobalData) const =0;
  
protected:
  FiniteDifferenceFunction() {}
  ~FiniteDifferenceFunction() {}
  void PrintSelf(std::ostream& os, Indent indent) const
  {
    Superclass::PrintSelf(os, indent);
    os << indent << "Radius: " << m_Radius << std::endl;
  }

  RadiusType m_Radius;

  static FloatOffsetType m_ZeroOffset;

private:
  FiniteDifferenceFunction(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  static FloatOffsetType InitializeZeroOffset();

};
  
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFiniteDifferenceFunction.txx"
#endif

#endif

---