itkCurvatureFlowFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCurvatureFlowFunction.h,v $
  Language:  C++
  Date:      $Date: 2008-10-23 16:15:23 $
  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 __itkCurvatureFlowFunction_h
#define __itkCurvatureFlowFunction_h

#include "itkFiniteDifferenceFunction.h"
#include "itkMacro.h"

namespace itk {

template <class TImage>
class ITK_EXPORT CurvatureFlowFunction :
    public FiniteDifferenceFunction<TImage>
{
public:
  typedef CurvatureFlowFunction            Self;
  typedef FiniteDifferenceFunction<TImage> Superclass;
  typedef SmartPointer<Self>               Pointer;
  typedef SmartPointer<const Self>         ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( CurvatureFlowFunction,
                FiniteDifferenceFunction );
  
  typedef typename Superclass::ImageType              ImageType;
  typedef typename Superclass::PixelType              PixelType;
  typedef typename Superclass::RadiusType             RadiusType;
  typedef PixelType                                   ScalarValueType;
  typedef typename Superclass::PixelRealType          PixelRealType;
  typedef typename Superclass::NeighborhoodType       NeighborhoodType;
  typedef typename Superclass::NeighborhoodScalesType NeighborhoodScalesType;
  typedef typename Superclass::FloatOffsetType        FloatOffsetType;
  typedef typename Superclass::TimeStepType           TimeStepType;

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

  virtual TimeStepType ComputeGlobalTimeStep(void *GlobalData) const;

  virtual void *GetGlobalDataPointer() const
    {  
    GlobalDataStruct *ans = new GlobalDataStruct();
    ans->m_MaxChange   = NumericTraits<ScalarValueType>::Zero;
    return ans; 
    }

  virtual void ReleaseGlobalDataPointer(void *GlobalData) const
    { delete (GlobalDataStruct *) GlobalData; }

  void SetTimeStep( const TimeStepType & t )
    { m_TimeStep = t; }

  const TimeStepType &GetTimeStep() const
    { return m_TimeStep; }

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

protected:


  struct GlobalDataStruct
    {
    GlobalDataStruct()
      {
      m_MaxChange = NumericTraits<ScalarValueType>::Zero;
      }
    ~GlobalDataStruct() {}
    
    ScalarValueType m_MaxChange;
    };

  CurvatureFlowFunction();
  ~CurvatureFlowFunction() {}

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

  TimeStepType       m_TimeStep;
  
  
};

}// end namespace itk

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

#endif