itkAnisotropicDiffusionFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkAnisotropicDiffusionFunction.h,v $
  Language:  C++
  Date:      $Date: 2008-10-07 14:49:29 $
  Version:   $Revision: 1.19 $

  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 __itkAnisotropicDiffusionFunction_h
#define __itkAnisotropicDiffusionFunction_h


#include "itkFiniteDifferenceFunction.h"

namespace itk {

template <class TImage>
class ITK_EXPORT AnisotropicDiffusionFunction :
    public FiniteDifferenceFunction<TImage>
{
public:

  typedef AnisotropicDiffusionFunction     Self;
  typedef FiniteDifferenceFunction<TImage> Superclass;
  typedef SmartPointer<Self>               Pointer;
  typedef SmartPointer<const Self>         ConstPointer;

  itkTypeMacro( AnisotropicDiffusionFunction, FiniteDifferenceFunction );

  typedef typename Superclass::ImageType        ImageType;
  typedef typename Superclass::PixelType        PixelType;
  typedef typename Superclass::PixelRealType    PixelrealType;
  typedef typename Superclass::RadiusType       RadiusType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;
  typedef typename Superclass::TimeStepType     TimeStepType;
  typedef typename Superclass::FloatOffsetType  FloatOffsetType;

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

  virtual void CalculateAverageGradientMagnitudeSquared(ImageType *) = 0;

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

  void SetConductanceParameter(const double &c)
    {
    m_ConductanceParameter = c;
    }
  const double &GetConductanceParameter() const
    {
    return m_ConductanceParameter;
    }

  const double &GetAverageGradientMagnitudeSquared() const
    {
    return m_AverageGradientMagnitudeSquared;
    }
  void SetAverageGradientMagnitudeSquared(const double &c)
    {
    m_AverageGradientMagnitudeSquared = c;
    }

  virtual TimeStepType ComputeGlobalTimeStep(void *itkNotUsed(GlobalData)) const
    {
    return this->GetTimeStep();
    }

  virtual void *GetGlobalDataPointer() const
    {
    return 0;
    }

  virtual void ReleaseGlobalDataPointer(void *itkNotUsed(GlobalData)) const
    {
    /* do nothing */
    }

protected:
  AnisotropicDiffusionFunction()
    {
    m_AverageGradientMagnitudeSquared = 0.0;
    m_ConductanceParameter     = 1.0;     // default value
    m_TimeStep                 = 0.125f;  // default value
    }
  ~AnisotropicDiffusionFunction() {}

  void PrintSelf(std::ostream& os, Indent indent) const
    {
    Superclass::PrintSelf(os,indent);
    os << indent << "TimeStep: " << m_TimeStep << std::endl;
    os << indent << "ConductanceParameter: " << m_ConductanceParameter <<
      std::endl;
    }

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

  double          m_AverageGradientMagnitudeSquared;
  double          m_ConductanceParameter;
  TimeStepType    m_TimeStep;
};

}// end namespace itk

#endif