itkFiniteDifferenceFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFiniteDifferenceFunction.h,v $
  Language:  C++
  Date:      $Date: 2008-10-16 23:25:41 $
  Version:   $Revision: 1.21 $

  Copyright (c) Insight Software 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 "itkZeroFluxNeumannBoundaryCondition.h"
#include "itkVector.h"
#include "itkFixedArray.h"

namespace itk {

template<class TImageType>
class ITK_EXPORT 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;
  typedef double                            PixelRealType;  

  itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);

  typedef double  TimeStepType;

  typedef ZeroFluxNeumannBoundaryCondition<ImageType>
    DefaultBoundaryConditionType;

  typedef typename ConstNeighborhoodIterator<TImageType>::RadiusType RadiusType;

  typedef ConstNeighborhoodIterator<TImageType, DefaultBoundaryConditionType> NeighborhoodType;

  typedef Vector<PixelRealType,itkGetStaticConstMacro(ImageDimension)> NeighborhoodScalesType;

  typedef Vector<float,itkGetStaticConstMacro(ImageDimension)> FloatOffsetType;

  virtual void InitializeIteration() {};

#if !defined(CABLE_CONFIGURATION)
  virtual PixelType  ComputeUpdate(const NeighborhoodType &neighborhood,
                                   void *globalData,
                                   const FloatOffsetType &offset = FloatOffsetType(0.0)) = 0;
#endif

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

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

  void SetScaleCoefficients (PixelRealType vals[ImageDimension])
    {
    for( unsigned int i = 0; i < ImageDimension; i++ )
      {
      m_ScaleCoefficients[i] = vals[i];
      }
    }

  const NeighborhoodScalesType ComputeNeighborhoodScales() const;

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

  virtual void *GetGlobalDataPointer() const =0;

  virtual void ReleaseGlobalDataPointer(void *GlobalData) const =0;

protected:
  FiniteDifferenceFunction() 
  {
    // initialize variables
    m_Radius.Fill( 0 );
    for (unsigned int i = 0; i < ImageDimension; i++)
      {
      m_ScaleCoefficients[i] = 1.0;
      }
  }
  ~FiniteDifferenceFunction() {}
  void PrintSelf(std::ostream& os, Indent indent) const;

  RadiusType m_Radius;
  PixelRealType m_ScaleCoefficients[ImageDimension];

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

// Define instantiation macro for this template.
#define ITK_TEMPLATE_FiniteDifferenceFunction(_, EXPORT, x, y) namespace itk { \
  _(1(class EXPORT FiniteDifferenceFunction< ITK_TEMPLATE_1 x >)) \
  namespace Templates { typedef FiniteDifferenceFunction< ITK_TEMPLATE_1 x > FiniteDifferenceFunction##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkFiniteDifferenceFunction+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkFiniteDifferenceFunction.txx"
#endif

#endif