itkLevelSetFunctionBase.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLevelSetFunctionBase.h,v $
  Language:  C++
  Date:      $Date: 2002/09/30 16:37:52 $
  Version:   $Revision: 1.3 $

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

#include "itkFiniteDifferenceFunction.h"
#include "itkVector.h"

namespace itk {

template <class TImageType>
class LevelSetFunctionBase : public FiniteDifferenceFunction<TImageType>
{
public:
  typedef LevelSetFunctionBase Self;
  typedef FiniteDifferenceFunction<TImageType> Superclass;
  typedef SmartPointer<Self> Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  itkTypeMacro( LevelSetFunctionBase,  FiniteDifferenceFunction );

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

  typedef double TimeStepType;
  typedef typename Superclass::ImageType  ImageType;
  typedef typename Superclass::PixelType  PixelType;
  typedef                      PixelType  ScalarValueType;
  typedef typename Superclass::RadiusType RadiusType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;
  typedef typename Superclass::BoundaryNeighborhoodType
                                                BoundaryNeighborhoodType;
  typedef typename Superclass::FloatOffsetType FloatOffsetType;
  
  typedef
    Vector<ScalarValueType, itkGetStaticConstMacro(ImageDimension)> VectorType;

  virtual VectorType AdvectionField(const NeighborhoodType &neighborhood,
                                    const FloatOffsetType &)  const
    { return m_ZeroVectorConstant; }
  virtual VectorType AdvectionField(const BoundaryNeighborhoodType
                                    &neighborhood, const FloatOffsetType &
                                    ) const
    { return m_ZeroVectorConstant; }

  virtual ScalarValueType PropagationSpeed(
    const NeighborhoodType& neighborhood,
    const FloatOffsetType ) const
    { return NumericTraits<ScalarValueType>::Zero; }
  virtual ScalarValueType PropagationSpeed(
    const BoundaryNeighborhoodType
    &neighborhood, const FloatOffsetType &) const
    { return NumericTraits<ScalarValueType>::Zero; }

  virtual ScalarValueType CurvatureSpeed(const NeighborhoodType
                                         &neighborhood, const FloatOffsetType &
                                         ) const
    { return NumericTraits<ScalarValueType>::One; }

  virtual ScalarValueType CurvatureSpeed(const BoundaryNeighborhoodType
                                         &neighborhood, const FloatOffsetType &
                                         ) const
    { return NumericTraits<ScalarValueType>::One; }

  void SetAdvectionWeight(const ScalarValueType a)
    { m_AdvectionWeight = a; }
  ScalarValueType GetAdvectionWeight() const
    { return m_AdvectionWeight; }
  
  void SetPropagationWeight(const ScalarValueType p)
    { m_PropagationWeight = p; }
  ScalarValueType GetPropagationWeight() const
    { return m_PropagationWeight; }
  
  void SetCurvatureWeight(const ScalarValueType c)
    { m_CurvatureWeight = c; }
  ScalarValueType GetCurvatureWeight() const
    { return m_CurvatureWeight; }
  
  void SetEpsilonMagnitude(const ScalarValueType e)
    { m_EpsilonMagnitude = e; }
  ScalarValueType GetEpsilonMagnitude() const
    { return m_EpsilonMagnitude; }

  virtual void Initialize(const RadiusType &r) =0;

protected:
  LevelSetFunctionBase()
    {
      m_EpsilonMagnitude = 1.0e-5;
      m_AdvectionWeight = m_PropagationWeight = m_CurvatureWeight =
        NumericTraits<ScalarValueType>::Zero;
    }
  ~LevelSetFunctionBase() {}

  void PrintSelf(std::ostream& os, Indent indent) const;

  static VectorType InitializeZeroVectorConstant();
  
  static VectorType m_ZeroVectorConstant;

  ScalarValueType m_EpsilonMagnitude;
  
  ScalarValueType m_AdvectionWeight;

  ScalarValueType m_PropagationWeight;

  ScalarValueType m_CurvatureWeight;

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

} // namespace itk

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

#endif

---