itkCurvatureFlowFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkCurvatureFlowFunction_h
#define __itkCurvatureFlowFunction_h

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

namespace itk
{
template< typename TImage >
class 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.hxx"
#endif

#endif