itkFastMarchingImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFastMarchingImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2003/09/10 14:28:30 $
  Version:   $Revision: 1.27 $

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

#include "itkImageToImageFilter.h"
#include "itkLevelSet.h"
#include "itkIndex.h"
#include "vnl/vnl_math.h"

#include <functional>
#include <queue>

namespace itk
{

template <
  class TLevelSet, 
  class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension> >
class ITK_EXPORT FastMarchingImageFilter :
    public ImageToImageFilter<TSpeedImage,TLevelSet>
{
public:
  typedef FastMarchingImageFilter Self;
  typedef ImageSource<TLevelSet> Superclass;
  typedef SmartPointer<Self> Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(FastMarchingImageFilter, ImageSource);

  typedef LevelSetTypeDefault<TLevelSet>  LevelSetType;
  typedef typename LevelSetType::LevelSetImageType  LevelSetImageType;
  typedef typename LevelSetType::LevelSetPointer  LevelSetPointer;
  typedef typename LevelSetType::PixelType  PixelType;
  typedef typename LevelSetType::NodeType NodeType;
  typedef typename LevelSetType::NodeContainer NodeContainer;
  typedef typename LevelSetType::NodeContainerPointer NodeContainerPointer;

  itkStaticConstMacro(SetDimension, unsigned int,
                      LevelSetType::SetDimension);

  typedef Index<itkGetStaticConstMacro(SetDimension)> IndexType;

  typedef TSpeedImage SpeedImageType;

  typedef typename SpeedImageType::Pointer        SpeedImagePointer;
  typedef typename SpeedImageType::ConstPointer   SpeedImageConstPointer;

  enum LabelType { FarPoint, AlivePoint, TrialPoint };

  typedef Image<unsigned char, itkGetStaticConstMacro(SetDimension)> LabelImageType;

  typedef typename LabelImageType::Pointer LabelImagePointer;

  void SetAlivePoints( NodeContainer * points )
  { 
    m_AlivePoints = points; 
    this->Modified(); 
  };

  NodeContainerPointer GetAlivePoints( )
  { return m_AlivePoints; };

  void SetTrialPoints( NodeContainer * points )
  { 
    m_TrialPoints = points;
    this->Modified();
  };

  NodeContainerPointer GetTrialPoints( )
  { return m_TrialPoints; };

  LabelImagePointer GetLabelImage() const
  { return m_LabelImage; };

  void SetSpeedConstant( double value )
  {
    m_SpeedConstant = value;
    m_InverseSpeed = -1.0 * vnl_math_sqr( 1.0 / m_SpeedConstant );
    this->Modified();
  }

  itkGetConstMacro( SpeedConstant, double );

  itkSetMacro( NormalizationFactor, double );
  itkGetMacro( NormalizationFactor, double );

  itkSetMacro( StoppingValue, double );

  itkGetConstMacro( StoppingValue, double );

  itkSetMacro( CollectPoints, bool );

  itkGetConstMacro( CollectPoints, bool );
  itkBooleanMacro( CollectPoints );

  NodeContainerPointer GetProcessedPoints() const
  { return m_ProcessedPoints; }

  void SetOutputSize( const typename LevelSetImageType::SizeType& size )
  { m_OutputSize = size; }

  const typename LevelSetImageType::SizeType & GetOutputSize() const
  { return m_OutputSize; }

protected:
  FastMarchingImageFilter();
  ~FastMarchingImageFilter(){};
  void PrintSelf( std::ostream& os, Indent indent ) const;

  virtual void Initialize( LevelSetImageType * );
  virtual void UpdateNeighbors( const IndexType& index, 
                                const SpeedImageType *, LevelSetImageType * );
  virtual double UpdateValue( const IndexType& index, 
                              const SpeedImageType *, LevelSetImageType * );


  const NodeType& GetNodeUsedInCalculation(unsigned int idx) const
  { return m_NodesUsed[idx]; }

  void GenerateData();

  virtual void GenerateOutputInformation();
  virtual void EnlargeOutputRequestedRegion(DataObject *output);

  itkGetConstMacro( LargeValue, PixelType );


private:
  FastMarchingImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  NodeContainerPointer                          m_AlivePoints;
  NodeContainerPointer                          m_TrialPoints;

  LabelImagePointer                             m_LabelImage;
  
  double                                        m_SpeedConstant;
  double                                        m_InverseSpeed;
  double                                        m_StoppingValue;
    
  bool                                          m_CollectPoints;
  NodeContainerPointer                          m_ProcessedPoints;

  typename LevelSetImageType::SizeType          m_OutputSize;
  typename LevelSetImageType::PixelType         m_LargeValue;
  NodeType                                      m_NodesUsed[SetDimension];

  typedef std::vector<NodeType> HeapContainer;
  typedef std::greater<NodeType> NodeComparer;
  typedef std::priority_queue< NodeType, HeapContainer, NodeComparer > HeapType;

  HeapType    m_TrialHeap;

  double    m_NormalizationFactor;
};

} // namespace itk


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

#endif

---